Update release details for GitHub

Signed-off-by: Callum Farmer <gmbr3@opensuse.org>
This commit is contained in:
Callum Farmer 2024-09-16 15:51:28 +01:00
parent 34c694069c
commit c9edd83549
No known key found for this signature in database
GPG Key ID: 9A5B19E18CD0013C
2 changed files with 22 additions and 21 deletions

View File

@ -1,21 +0,0 @@
README.git
Generating releases from git a very simple process;
1) Edit the file "Makefile". Changing the "VERSION" line to the new version.
2) Do a "git commit" just for the version number change.
3) Then do a "make test-archive".
That will make a file in the current directory gnu-efi-$VERSION.tar.bz2 ,
with its top level directory gnu-efi-$VERSION/ and the source tree under that.
Once you've tested that and you're sure it's what you want to release,
4) Do "make archive", which will tag a release in git and generate a
final tarball from it.
You then push to the archive, being sure to include the tag:
5) "git push origin master:master --tags"
And upload the archive wherever it's supposed to go.

22
docs/README.git.md Normal file
View File

@ -0,0 +1,22 @@
# README.git
Generating releases on GitHub is a very simple process;
## Set version in repo
1) Edit the file "Makefile". Changing the "VERSION" line to the new version.
2) Do a "git commit" just for the version number change.
## Create new release
1) Go to the [GitHub release page](https://github.com/ncroxon/gnu-efi/releases/new)
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**
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