Making a tag in NorESM

[gold2718]

This item contains (possibly evolving) instructions on how to make a new tag for NorESM or one of its external component models or utility externals.
The goal is to create an annotated (documented) tag that points to the desired commit. An outline of the procedure is:

1. Merge a GitHub Pull Request (PR) with a 'complete' commit message. The message can (should) come from the PR description. Some useful items to have in the message are:
   • A description of the work the PR represents (e.g., the new feature being introduced, the bug being fixed, the runtime settings being introduced or updated)
   • A title and URL for any GitHub issues being addressed
   • All tests that were run including any that failed
2. In a local clone, update your NorESMhub remote. A good way to do this is git fetch --tags <remote> where <remote> is the name of your NorESM remote (run git remote -v if you are not sure).
3. Make sure you have access to the PR merge commit message (either from the PR description or by typing git log --max-count=1 <remote>/<branch> where <remote> is the name of your NorESM remote and <branch> is the name of the branch you just merged to). You will use this text as your tag commit message.
4. Decide on a tag name (<tag> below). Hopefully, this is the first part of the PR title.
5. Make an annotated tag. This is done with the -a option to the git tag command line.
   git tag -a <tag> <remote>/<branch>
   This will bring up your git editor where you can paste in and edit the commit message. The standard commit message format is a short, descriptive first line, a blank line, then the rest of the commit message. If copying text from the git log, you can omit the merge message (Merge pull request #xxx from <fork>/<branch>).
6. Check that the tag points to the correct commit using git describe <remote>/<branch>.
   • The output should be exactly the tag name (<tag>).
   • If the output is anything else, remove the tag (git tag --delete <tag>) and repeat steps beginning at 2 correcting any mistakes.
7. Finally, push the tag to NorESMhub (git push <remote> <tag>).