kemitix/git-next
1
1
Fork 1
Code Issues 17 Pull requests 2 Projects 1 Releases 41 Packages 2 Wiki Activity Actions

docs: add notes on how to do a release
All checks were successful
Rust / build (push) Successful in 7m24s
Details
ci/woodpecker/push/cron-docker-builder Pipeline was successful
Details
ci/woodpecker/push/push-next Pipeline was successful
Details
ci/woodpecker/push/tag-created Pipeline was successful
Details
Release Please / Release-plz (push) Successful in 3m22s
Details
ci/woodpecker/cron/cron-docker-builder Pipeline was successful
Details
ci/woodpecker/cron/push-next Pipeline was successful
Details
ci/woodpecker/cron/tag-created Pipeline was successful
Details

Browse source
This commit is contained in:
Paul Campbell 2024-08-25 19:28:47 +01:00
parent 76ae37a9a5
commit 48a5ed7a3b
1 changed files with 18 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
RELEASE.md Normal file
View file

@ -0,0 +1,18 @@
# How to create a new Release
## TLDR
1. Merge PR `chore: release`
2. Wait for `push-main` workflow to complete
3. Replace Release Notes body with details from CHANGELOG (remove crates and duplicates)
4. Update thread: <https://mitra.kemitix.net/post/01907ef5-5bd9-b0b6-2b8a-e29762541d78>
## Detail
The workflow in `.forgejo/workflows/push-main.yaml` will create or update a PR whenever `main` branch is updated.
The create the new release, merge this PR. It will automatically create the Release on the `git-next` repo, and publish crates to <https://crates/io>.
The Release notes that are included with the create Release are currently incorrect, and will need to be manually updated from the `CHANGELOG.md`. Remove crate headers and any resulting duplicates.
Post an update to the Fediverse. See link above.