1<!--
2SPDX-FileCopyrightText: Amolith <amolith@secluded.site>
3
4SPDX-License-Identifier: CC0-1.0
5-->
6
7# Willow
8
9[![Go report card status][goreportcard-badge]][goreportcard]
10[![REUSE status][reuse-shield]][reuse]
11[![Donate with fosspay][fosspay-shield]][fosspay]
12
13_Forge-agnostic software release tracker_
14
15
16
17_This UI is a minimal proof-of-concept, it's going to change drastically in the
18near future._
19
20## What is it?
21
22Willow tracks software releases across arbitrary forge platforms by trying to
23support one of the very few things they all have in common: the VCS. At the
24moment, git is the _only_ supported VCS, but I would be interested in adding
25Pijul, Fossil, Mercurial, etc. You can also track releases using RSS feeds.
26
27Willow exists because decentralisation can be annoying. One piece of software
28can be found on GitHub, another piece on GitLab, one on Bitbucket, a fourth on
29SourceHut, and a fifth on the developer's self-hosted Forgejo instance. Forgejo
30and GitHub have RSS feeds that only notify you of releases. GitLab doesn't
31support RSS feeds for anything, just an API you can poke. Some software updates
32might be on the developers' personal blog. Sometimes there are CVEs for specific
33software and they get published somewhere completely different before they're
34fixed in a release.
35
36I want to bring all that scattered information under one roof so a developer or
37sysadmin can pop open willow's web UI and immediately see what needs updating
38where. I've recorded some of my other ideas and plans in [my wiki].
39
40[my wiki]: https://wiki.secluded.site/hypha/willow
41
42## Installation and use
43
44* Clone the repo
45* Build the binary with `CGO_ENABLED=0 go build .`
46* Upload it to a remote server
47* Execute the binary
48* Reverse proxy `localhost:1337`
49* Open the web UI
50* Click `Track new project`
51* Fill out the form
52* Indicate which version you're currently on
53* That's it!
54
55Note that there's currently no authentication, so consider putting your instance
56behind HTTP Basic Auth, keeping it private, or helping me implement
57authentication.
58
59## Contributing
60
61Contributions are very much welcome! Please take a look at the [ticket
62tracker][todo] and see if there's anything you're interested in working on. If
63there's specific functionality you'd like to see implemented and it's not
64mentioned in the ticket tracker, please post to the [mailing list][email] and
65describe the feature.
66
67Questions, comments, and patches can always be sent to the [mailing
68list][email], but I'm also in the [IRC channel][irc]/[XMPP room][xmpp] pretty
69much 24/7. However, I might not see messages right away because I'm working on
70something else (or sleeping) so please stick around.
71
72If you're wanting to introduce a new feature and I don't feel like it fits with
73this project's goal, I encourage you to fork the repo and make whatever changes
74you like!
75
76- Email: [~amolith/willow@lists.sr.ht][email]
77- IRC: [irc.libera.chat/#willow][irc]
78- XMPP: [willow@muc.secluded.site][xmpp]
79
80[email]: mailto:~amolith/willow@lists.sr.ht
81[irc]: irc://irc.nixnet.services/#willow
82[xmpp]: xmpp:willow@muc.secluded.site?join
83[todo]: https://todo.sr.ht/~amolith/willow
84
85_If you haven't used mailing lists before, please take a look at [SourceHut's
86documentation](https://man.sr.ht/lists.sr.ht/), especially the etiquette
87section._
88
89### Required tools
90
91- [Go](https://go.dev/)
92- [gofumpt](https://github.com/mvdan/gofumpt)
93 - Stricter formatting rules than the default `go fmt`
94- [golangci-lint](https://golangci-lint.run/)
95 - Aggregates various preinstalled Go linters, runs them in parallel, and makes
96 heavy use of the Go build cache
97- [Staticcheck](https://staticcheck.dev/)
98 - Uses static analysis to find bugs and performance issues, offer
99 simplifications, and enforce style rules
100
101### Suggested tools
102
103- [just](https://github.com/casey/just)
104 - Command runner to simplify use of the required tools
105
106### Configuring git for git send-email
107
108First, go through the tutorial on
109[git-send-email.io](https://git-send-email.io/).
110
111``` shell
112git config sendemail.to "~amolith/willow@lists.sr.ht"
113```
114
115[goreportcard-badge]: https://goreportcard.com/badge/git.sr.ht/~amolith/willow
116[goreportcard]: https://goreportcard.com/report/git.sr.ht/~amolith/willow
117[reuse]: https://api.reuse.software/info/git.sr.ht/~amolith/willow
118[reuse-shield]: https://shields.io/reuse/compliance/git.sr.ht/~amolith/willow
119[fosspay]: https://secluded.site/donate/
120[fosspay-shield]: https://shields.io/badge/donate-fosspay-yellow