Enable automatic GitHub Release generation

This commit is contained in:
Jonah Aragon 2022-08-24 20:30:40 -05:00
parent f255d49760
commit ba7b53aceb
No known key found for this signature in database
2 changed files with 3 additions and 3 deletions

View File

@ -15,6 +15,5 @@ jobs:
- uses: actions/checkout@v2
- uses: ncipollo/release-action@v1
with:
draft: true
generateReleaseNotes: true
token: ${{ secrets.REPO_TOKEN }}

View File

@ -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.