Skip to content

Commit

Permalink
Add more notes to GitHub release info
Browse files Browse the repository at this point in the history
* Just to ensure GitHub doesn't run anyway with the hills

Signed-off-by: Callum Farmer <gmbr3@opensuse.org>
  • Loading branch information
gmbr3 committed Sep 23, 2024
1 parent 7665a48 commit 85615e2
Showing 1 changed file with 14 additions and 4 deletions.
18 changes: 14 additions & 4 deletions docs/README.git.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,21 @@ Generating releases on GitHub is a very simple process;
2) Enter the version number in the tag field, selecting "create tag on publish"

**Ignore GitHub's suggestion of prefixing the version with a "v"**
3) **OPTIONAL**
3) Set previous tag manually

Last stable for stable releases
Last alpha/beta for alpha/beta releases

**Ensures GitHub sets the Full Changelog to be between the last release in the cycle**
**and not the start of the repository**
4) Add a release title - use the version number

**Otherwise GitHub will add the last commit name as the title**
5) **OPTIONAL**
Add a release description and/or a list of pull requests and contributors via "Generate release notes"
4) For alpha/beta versions, set it to be a pre-release
5) Release the new version
6) GitHub will automatically generate a GZ compressed TAR file and a ZIP file of the repo
6) For alpha/beta versions, set it to be a pre-release
7) Release the new version
8) GitHub will automatically generate a GZ compressed TAR file and a ZIP file of the repo



Expand Down

0 comments on commit 85615e2

Please sign in to comment.