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
22_If you'd rather watch a video, I gave a [lightning talk on Willow] at the 2023
23Ubuntu Summit._
24
25[lightning talk on Willow]: https://youtu.be/XIGxKyekvBQ?t=29900
26
27Willow tracks software releases across arbitrary forge platforms by trying to
28support one of the very few things they all have in common: the VCS. At the
29moment, git is the _only_ supported VCS, but I would be interested in adding
30Pijul, Fossil, Mercurial, etc. You can also track releases using RSS feeds.
31
32Willow exists because decentralisation can be annoying. One piece of software
33can be found on GitHub, another piece on GitLab, one on Bitbucket, a fourth on
34SourceHut, and a fifth on the developer's self-hosted Forgejo instance. Forgejo
35and GitHub have RSS feeds that only notify you of releases. GitLab doesn't
36support RSS feeds for anything, just an API you can poke. Some software updates
37might be on the developers' personal blog. Sometimes there are CVEs for specific
38software and they get published somewhere completely different before they're
39fixed in a release.
40
41I want to bring all that scattered information under one roof so a developer or
42sysadmin can pop open willow's web UI and immediately see what needs updating
43where. I've recorded some of my other ideas and plans in [my wiki].
44
45[my wiki]: https://wiki.secluded.site/hypha/willow
46
47## Installation and use
48
49_**Note:** prebuilt binaries will be available after I release [v0.0.1]_
50
51[v0.0.1]: https://todo.sr.ht/~amolith/willow?search=status%3Aopen%20label%3A%22v0.0.1%22
52
53* Clone the repo
54* Build the binary with `CGO_ENABLED=0 go build -ldflags="-s -w" -o willow ./cmd`
55* Upload it to a remote server
56* Execute the binary
57* Edit the `config.toml`
58* Create a user with `./willow -a <username>`
59* Execute the binary again
60* Reverse proxy `http://localhost:1313`
61* Open the web UI
62* Click `Track new project`
63* Fill out the form
64* Indicate which version you're currently on
65* That's it!
66
67Note that I still consider the project to be in _alpha_ state. There will be
68bugs; please help fix them!
69
70## Contributing
71
72Contributions are very much welcome! Please take a look at the [ticket
73tracker][todo] and see if there's anything you're interested in working on. If
74there's specific functionality you'd like to see implemented and it's not
75mentioned in the ticket tracker, please post to the [mailing list][email] and
76describe the feature.
77
78Questions, comments, and patches can always be sent to the [mailing
79list][email], but I'm also in the [IRC channel][irc]/[XMPP room][xmpp] pretty
80much 24/7. However, I might not see messages right away because I'm working on
81something else (or sleeping) so please stick around.
82
83If you're wanting to introduce a new feature and I don't feel like it fits with
84this project's goal, I encourage you to fork the repo and make whatever changes
85you like!
86
87- Email: [~amolith/willow@lists.sr.ht][email]
88- IRC: [irc.libera.chat/#willow][irc]
89- XMPP: [willow@muc.secluded.site][xmpp]
90
91[email]: mailto:~amolith/willow@lists.sr.ht
92[irc]: irc://irc.nixnet.services/#willow
93[xmpp]: xmpp:willow@muc.secluded.site?join
94[todo]: https://todo.sr.ht/~amolith/willow
95
96_If you haven't used mailing lists before, please take a look at [SourceHut's
97documentation](https://man.sr.ht/lists.sr.ht/), especially the etiquette
98section._
99
100### Required tools
101
102- [Go](https://go.dev/)
103- [gofumpt](https://github.com/mvdan/gofumpt)
104 - Stricter formatting rules than the default `go fmt`
105- [golangci-lint](https://golangci-lint.run/)
106 - Aggregates various preinstalled Go linters, runs them in parallel, and makes
107 heavy use of the Go build cache
108- [Staticcheck](https://staticcheck.dev/)
109 - Uses static analysis to find bugs and performance issues, offer
110 simplifications, and enforce style rules
111
112### Suggested tools
113
114- [just](https://github.com/casey/just)
115 - Command runner to simplify use of the required tools
116- [air](https://github.com/cosmtrek/air)
117 - Watches source files and rebuilds/executes the project when sources change
118
119### Configuring git for git send-email
120
121First, go through the tutorial on
122[git-send-email.io](https://git-send-email.io/).
123
124``` shell
125git config sendemail.to "~amolith/willow@lists.sr.ht"
126```
127
128[goreportcard-badge]: https://goreportcard.com/badge/git.sr.ht/~amolith/willow
129[goreportcard]: https://goreportcard.com/report/git.sr.ht/~amolith/willow
130[reuse]: https://api.reuse.software/info/git.sr.ht/~amolith/willow
131[reuse-shield]: https://shields.io/reuse/compliance/git.sr.ht/~amolith/willow
132[fosspay]: https://secluded.site/donate/
133[fosspay-shield]: https://shields.io/badge/donate-fosspay-yellow