From ba7b53acebec1648086112f94adead24422c2f90 Mon Sep 17 00:00:00 2001 From: Jonah Aragon Date: Wed, 24 Aug 2022 20:30:40 -0500 Subject: [PATCH] Enable automatic GitHub Release generation --- .github/workflows/release.yml | 1 - README.md | 5 +++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 1175653f..946cc0d0 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -15,6 +15,5 @@ jobs: - uses: actions/checkout@v2 - uses: ncipollo/release-action@v1 with: - draft: true generateReleaseNotes: true token: ${{ secrets.REPO_TOKEN }} diff --git a/README.md b/README.md index 99b6b251..8bb39371 100644 --- a/README.md +++ b/README.md @@ -110,6 +110,7 @@ If you commit to `main` with commits signed with your SSH key, you should add yo 1. Create a new tag: `git tag -s v2.X.X -m 'Some message'` - [View existing tags](https://github.com/privacyguides/privacyguides.org/tags) - Tag [numbering](https://semver.org/): Increment the MINOR (2nd) number when making significant changes (adding/deleting pages, etc.), increment the PATCH (3rd) number when making minor changes (typos, bug fixes). Probably leave the MAJOR number at 2 until a massive revamp (v1 -> v2 was the Jekyll to MkDocs transition). + - Consider enabling GPG tag signing by default (`git config tag.gpgSign true`) to avoid missing signatures 2. Push the tag to GitHub: `git push --tags` -3. A draft release will be created on GitHub. Publish the release and it will be deployed to the live site automatically. - - When publishing more significant releases (generally any with a MINOR version increment) check the "Create a discussion for this release" box to post an announcement +3. A GitHub Release will be automatically created and deployed to the live site. + - You may wish to manually check or edit the release changelog/title after it is published for accuracy.