Release v0.2.3
This commit is contained in:
@@ -56,4 +56,29 @@ The app is an Axum HTTP server with shared state (`AppState`) containing two com
|
||||
|
||||
## Releases
|
||||
|
||||
Pushing a `v*` tag triggers the GitHub Actions release workflow, which builds a Linux binary and uploads it to a GitHub Release.
|
||||
Pushing a `v*` tag triggers the Gitea Actions release workflow, which builds a
|
||||
Linux binary, uploads it to a Gitea Release, and pushes a Docker image to the
|
||||
Gitea container registry.
|
||||
|
||||
### Cutting a release
|
||||
|
||||
1. Move the `[Unreleased]` entries in `CHANGELOG.md` to a new versioned section:
|
||||
```markdown
|
||||
## [0.x.y] - YYYY-MM-DD
|
||||
```
|
||||
2. Add a new empty `## [Unreleased]` section at the top.
|
||||
3. Update the comparison links at the bottom of `CHANGELOG.md`:
|
||||
- Change the `[Unreleased]` link to compare the new tag against `HEAD`.
|
||||
- Add a new link for the new version comparing it against the previous tag.
|
||||
4. Commit: `git commit -m "Release v0.x.y"`
|
||||
5. Tag and push:
|
||||
```bash
|
||||
git tag v0.x.y
|
||||
git push origin main v0.x.y
|
||||
```
|
||||
|
||||
### Changelog conventions
|
||||
|
||||
`CHANGELOG.md` follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
|
||||
Group entries under: `Added`, `Changed`, `Deprecated`, `Removed`, `Fixed`, `Security`.
|
||||
Record notable changes in `[Unreleased]` as you make them, not only at release time.
|
||||
|
||||
Reference in New Issue
Block a user