Amolith
/
willow
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
WIP forge-agnostic software release tracker https://earl.run/willow
10 Commits 3 Branches 0 Tags 1.1 MiB
Go 75.3%
HTML 16.5%
CSS 6.8%
Just 1.4%
Go to file
Amolith 1750d9e0e0
move HTML template copyright to separate file 
Implements: https://todo.sr.ht/~amolith/willow/1
 		2023-09-25 23:58:54 -04:00
.reuse initial sourcehut commit 2023-09-21 14:03:21 -04:00
LICENSES initial sourcehut commit 2023-09-21 14:03:21 -04:00
screenshots reuse compliance 2023-09-24 16:57:56 -04:00
static move HTML template copyright to separate file 2023-09-25 23:58:54 -04:00
.gitignore reuse compliance 2023-09-24 16:57:56 -04:00
.golangci.toml add justfile and ci-lint config 2023-09-24 17:07:42 -04:00
README.md update tagline 2023-09-24 17:34:48 -04:00
git.go comment out listRemoteTags 2023-09-24 17:02:00 -04:00
go.mod reuse compliance 2023-09-24 16:57:56 -04:00
go.sum initial sourcehut commit 2023-09-21 14:03:21 -04:00
go.sum.license reuse compliance 2023-09-24 16:57:56 -04:00
justfile add justfile and ci-lint config 2023-09-24 17:07:42 -04:00
main.go reuse compliance 2023-09-24 16:57:56 -04:00
releases.go reuse compliance 2023-09-24 16:57:56 -04:00
rss.go reuse compliance 2023-09-24 16:57:56 -04:00
ws.go check error returns 2023-09-24 17:08:00 -04:00

README.md

Willow

Go report card status REUSE status Donate with fosspay

Forge-agnostic software release tracker

screenshot of willow's current web UI

This UI is a minimal proof-of-concept, it's going to change drastically in the near future.

What is it?

Willow tracks software releases across arbitrary forge platforms by trying to support one of the very few things they all have in common: the VCS. At the moment, git is the only supported VCS, but I would be interested in adding Pijul, Fossil, Mercurial, etc. You can also track releases using RSS feeds.

Willow exists because decentralisation can be annoying. One piece of software can be found on GitHub, another piece on GitLab, one on Bitbucket, a fourth on SourceHut, and a fifth on the developer's self-hosted Forgejo instance. Forgejo and GitHub have RSS feeds that only notify you of releases. GitLab doesn't support RSS feeds for anything, just an API you can poke. Some software updates might be on the developers' personal blog. Sometimes there are CVEs for specific software and they get published somewhere completely different before they're fixed in a release.

I want to bring all that scattered information under one roof so a developer or sysadmin can pop open willow's web UI and immediately see what needs updating where. I've recorded some of my other ideas and plans in my wiki.

Installation and use

  • Clone the repo
  • Build the binary with CGO_ENABLED=0 go build .
  • Upload it to a remote server
  • Execute the binary
  • Reverse proxy localhost:1337
  • Open the web UI
  • Click Track new project
  • Fill out the form
  • Indicate which version you're currently on
  • That's it!

Note that there's currently no authentication, so consider putting your instance behind HTTP Basic Auth, keeping it private, or helping me implement authentication.

Contributing

Contributions are very much welcome! Please take a look at the ticket tracker and see if there's anything you're interested in working on. If there's specific functionality you'd like to see implemented and it's not mentioned in the ticket tracker, please post to the mailing list and describe the feature.

Questions, comments, and patches can always be sent to the mailing list, but I'm also in the IRC channel/XMPP room pretty much 24/7. However, I might not see messages right away because I'm working on something else (or sleeping) so please stick around.

If you're wanting to introduce a new feature and I don't feel like it fits with this project's goal, I encourage you to fork the repo and make whatever changes you like!

If you haven't used mailing lists before, please take a look at SourceHut's documentation, especially the etiquette section.

Required tools

  • Go
  • gofumpt
    • Stricter formatting rules than the default go fmt
  • golangci-lint
    • Aggregates various preinstalled Go linters, runs them in parallel, and makes heavy use of the Go build cache
  • Staticcheck
    • Uses static analysis to find bugs and performance issues, offer simplifications, and enforce style rules

Suggested tools

  • just
    • Command runner to simplify use of the required tools

Configuring git for git send-email

First, go through the tutorial on git-send-email.io.

git config sendemail.to "~amolith/willow@lists.sr.ht"