-
-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(release): Add release steps (#191)
* chore(release): Add release steps Add a RELEASE.md file containing every steps required to create a new release Closes #183
- Loading branch information
Showing
3 changed files
with
94 additions
and
44 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| # Creating a release | ||
|
|
||
| - Make sure that `git-cliff` is installed and `arch-update` is up to date on your system. | ||
|
|
||
| - Export a `TAG` variable containing the new tag for the release: | ||
|
|
||
| ```bash | ||
| export TAG="X.Y.Z" | ||
| ``` | ||
|
|
||
| - Bump version in where necessary: | ||
|
|
||
| ```bash | ||
| sed -i "s/$(arch-update -V | cut -f2 -d " ")/${TAG}/g" doc/man/arch-update.* doc/man/fr/arch-update.* po/* src/script/arch-update.sh | ||
| ``` | ||
|
|
||
| - Update changelog: | ||
|
|
||
| ```bash | ||
| git-cliff -up CHANGELOG.md | ||
| sed -i "s|\[unreleased\]|\[v${TAG}\](https://github.com/Antiz96/arch-update/releases/tag/v${TAG})\ -\ $(date '+%Y-%m-%d')|g" CHANGELOG.md | ||
| ``` | ||
|
|
||
| - Commit, sign and push changes directly to the **main branch** *(we want the tagged commit to be signed with the [OpenPGP Key](https://keyserver.ubuntu.com/pks/lookup?search=D33FAA16B937F3B2&fingerprint=on&op=index) listed in [MAINTAINERS.md](https://github.com/Antiz96/arch-update/blob/main/MAINTAINERS.md) and not with the GitHub signature key automatically used when merging a pull request; this implies **temporarily** allowing administrators to bypass branch protections rules)*: | ||
|
|
||
| ```bash | ||
| git add . | ||
| git commit -SD33FAA16B937F3B2 -m "chore(release): v${TAG}" | ||
| git push | ||
| ``` | ||
|
|
||
| - Create, sign and push the new tag: | ||
|
|
||
| ```bash | ||
| git tag v${TAG} -u D33FAA16B937F3B2 -m "v${TAG}" | ||
| git push origin v${TAG} | ||
| ``` | ||
|
|
||
| - Create a release on GitHub, copy/paste release notes from the changelog and sign the auto-generated source tarball: | ||
|
|
||
| ```bash | ||
| cd ~/Downloads | ||
| curl https://github.com/Antiz96/arch-update/archive/refs/tags/v${TAG}.tar.gz -o arch-update-${TAG}.tar.gz | ||
| gpg --local-user D33FAA16B937F3B2 --armor --detach-sign arch-update-${TAG}.tar.gz | ||
| sha256sum arch-update-${TAG}.tar.gz > arch-update-${TAG}.tar.gz.sha256 | ||
| gpg --local-user D33FAA16B937F3B2 --armor --detach-sign arch-update-${TAG}.tar.gz.sha256 | ||
| rm -f arch-update-${TAG}.tar.gz | ||
| ``` | ||
|
|
||
| - Upload the 3 produced files as assets in the release and re-enable the branch protection rules on the main branch for administrators. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters