Release Workflow

Release Workflow

Merge latest PRs

• Merge latest Pull Requests into master that are for the latest milestone
• Pull Requests and Bug Fixes go directly into master after basic testing

Run release script

• Change to scripts dir (@todo fix reliance on dir)

  # todo fixme
  cd bin/scripts

• Execute script

  ./release.sh <version>

Update changelog

• Manually update the changelog.md with all changes
  • see most recent release for example of the format: https://github.com/ryanoasis/nerd-fonts/releases
  • make sure to credit each Pull Request by referencing the person with @ followed by their GitHub id
  • the following is a template example:

## v<version>
### New Features

  - Added xyz (fixes #101)
  - Added ...

### Updates / Improvements

  - Updated xyz (fixes #101) (PR #101 @someone)
  - ...

### Fixes

  - Fixed xyz (fixes #101) (PR #101 @someone)
  - ...

• see diff comparison from last release vs master to ensure nothing is missed: https://github.com/ryanoasis/nerd-fonts/compare/latest-release-branch...master
  • e.g. https://github.com/ryanoasis/nerd-fonts/compare/1.0.0...master

Update readme

• Update the readme.md
  • If a new font was added, add it to the table of Patched Fonts
  • Update the "counts" in the Features Section
    • You can get this information by simply passing a second param to the "all patcher": ./gotta-patch-em-all-font-patcher\!.sh "" info
      • "X already patched font families" -> Give exact number from 'typefaces' line
      • "Over X unique combinations/variations..." -> round down to nearest hundred from 'variation' line
      • "Over X glyphs/icons combined" -> manual process for now (@todo)
  • Update the "counts" in the Combinations Section
    • Again, get this info from the "all patcher"
  • Update the font-patcher help output section under "Patch Your Own Font" if needed

Create release on GitHub

• verify master branch has all changes commited and pushed
  • git status -s
• update master from remote
  • git pull origin master
• create the new branch
  • verify what the version should be by double checking remote branches
    • git branch -r | grep '[0-9]\+\.[0-9]\+\.[0-9]\+$'
  • git checkout -b <semver_based_branch_name>
• push the new branch
  • git push -u origin <semver_based_branch_name>
• create tag
  • "vMAJOR.MINOR.PATCH"
  • i.e. same as branch name but with prefixed with a 'v'
  • e.g. git tag v1.5.3
• push latest tags
  • git push --tags
• Create new release on GitHub
  • copy and paste latest release details from changelog.md into release notes

Run upload script

• Execute upload-archives.sh to upload font archives to the latest release
  • with no parameter given it will upload to the 'latest' release via GitHub API

Verify uploaded files

• Verify font archives are showing for latest release

Update website (github pages)

• Checkout branch: gh-pages
• Update the download links
  • If there are new fonts add the new links
• Update the release notes