From 6c38bdd16d51b07ed33431ecd9f918f456c55cbb Mon Sep 17 00:00:00 2001 From: Robin Candau Date: Thu, 4 Jul 2024 00:18:22 +0200 Subject: [PATCH] style(release): Start ordered list at '1.' Addresses [MD029](https://github.com/markdownlint/markdownlint/blob/main/docs/RULES.md#md029---ordered-list-item-prefix) --- RELEASE.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/RELEASE.md b/RELEASE.md index aba3317..1bbb2a6 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -1,27 +1,27 @@ # Creating a release -0. Make sure that `git-cliff` is installed and `arch-update` is up to date on your system. +1. Make sure that `git-cliff` is installed and `arch-update` is up to date on your system. -1. Export a `TAG` variable containing the new tag for the release: +2. Export a `TAG` variable containing the new tag for the release: ```bash export TAG="X.Y.Z" ``` -2. Bump version in where necessary: +3. 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 ``` -3. Update changelog: +4. 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 ``` -4. 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*: +5. 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 . @@ -29,14 +29,14 @@ git commit -SD33FAA16B937F3B2 -m "chore(release): v${TAG}" git push ``` -5. Create, sign and push the new tag: +6. Create, sign and push the new tag: ```bash git tag v${TAG} -u D33FAA16B937F3B2 -m "v${TAG}" git push origin v${TAG} ``` -6. Create a release on GitHub, copy/paste release notes from the changelog and sign the auto-generated source tarball: +7. Create a release on GitHub, copy/paste release notes from the changelog and sign the auto-generated source tarball: ```bash cd ~/Downloads @@ -47,4 +47,4 @@ gpg --local-user D33FAA16B937F3B2 --armor --detach-sign arch-update-${TAG}.tar.g rm -f arch-update-${TAG}.tar.gz ``` -7. Upload the 3 produced files as assets in the release and re-enable the branch protection rules on the main branch for administrators. +8. Upload the 3 produced files as assets in the release and re-enable the branch protection rules on the main branch for administrators.