GitHub Procedures

Internal

• GitHub

Making a Public Release

Overview

This is the procedure to make a "public release" for a GitHub-hosted project. This type of releases are accessible via the GitHub project page -> "releases" tab. The release procedure assumes that the release tag was already applied to the repository, either manually or via nort. At the time of the writing, nort is being extended to automate this procedure.

Procedure

Project Home -> "releases" tab -> "Draft a new release"

Copy and paste the release tag from the local release procedure output. The format is similar to "[project-name-]release-4.2.2".

Upon pasting it into the release input box, the site should recognize it as "Existing tag".

Release title: 4.2.2

Describe the release:

Specify Introduced features and defect fixes. This will be part of the release history. Projects maintain notes to be consolidated into the release announcement in ./doc/release-notes.txt. Copy and edit the content from there.

Attached files:

• If is an installable release, attach binaries: "Attach binaries by dropping them or selecting them."
• If it is a library release, don't attach anything, as the libraries can be recreated from the tagged source tree, and in the future, we'll publish to a public Maven repository.

"Publish release"

Clean ./doc/release-notes.txt and commit.

cat /dev/null > ./doc/release-notes.txt
git add ./doc/release-notes.txt
git commit -m "cleaned ./doc/release-notes.txt post-release"
git push