When tagging a new release please follow this checklist so that the documentation will be updated correctly, and version strings will remain accurate.
git checkout master
CHANGELOG.md
.VERSION
. If you have updated
.VERSION
then edit the URL manually to view the
changes.github_changelog_generator
as follows, and compare the output to the
unreleased
section of the CHANGELOG.md
:
github_changelog_generator --user jacobwilliams --project json-fortran -o Unreleased.md
--unreleased-only --bugs-label "**Fixed issues:**"
--enhancement-label "**Enhancements:**" --issues-label
"**Fixed issues:**"
and make sure that you have a
16-digit GitHub token stored in the environment variable
CHANGELOG_GITHUB_TOKEN
. Compare generated
Unreleased.md
to the “Unreleased” section of
CHANGELOG.md
and make updates as needed.HEAD
in the header URL with the new version
numberHEAD
in the “Complete Changeset” link with the
new version number.CHANGELOG.md
to the git index: git add CHANGELOG.md
pages/releases/index.md
under the “Past
Releases” headingpages/releases/index.md
to the git index: git add pages/releases/index.md
.VERSION
fileREADME.md
json_fortran_version
string in json_module.F90
git add .VERSION README.md ./src/json_module.F90
git commit
git tag <new version>
git describe
the project. Tagging from the command line makes git describe
work as expected.git push --tags origin master
cd $(brew
--repository)/Library/Formula
git remote add
YOUR_USERNAME https://github.com/YOUR_USERNAME/homebrew.git
git checkout master
brew update
(this calls
git pull
)git
checkout -b YOUR_BRANCH_NAME origin/master
json-fortran.rb
formula with brew edit
json-fortran
brew audit --strict --online json-fortran
brew rm json-fortran
brew install -v json-fortran
brew test -v json-fortran
json-fortran.rb
to the index (git add json-fortran.rb
)git
commit -m "json-fortran <new-version-string-here>"
git push --set-upstream
YOUR_USERNAME YOUR_BRANCH_NAME