-
Notifications
You must be signed in to change notification settings - Fork 3.7k
Release Workflow
Ryan L McIntyre edited this page Aug 6, 2017
·
19 revisions
- Merge latest Pull Requests into
master
that are for the latest milestone - Pull Requests and Bug Fixes go directly into
master
after basic testing
- Execute
release.sh <version>
- 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
- 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)
- "
- You can get this information by simply passing a second param to the "all patcher":
- 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
- verify
master
branch has all changes commited and pushedgit status -s
- update
master
from remotegit 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>
- verify what the version should be by double checking remote branches
- 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
- copy and paste latest release details from
- 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 font archives are showing for latest release
This Wiki and the Readme contains a lot of information, please take your time to read the information.
If you run into any trouble, please start by looking in the FAQ and if you still need help you can visit the Gitter Chat.
There is a heavily detailed Changelog and Release changes.
Be sure to read the Contributing Guide before opening a pull request to Nerd Fonts.
If you have any questions about the Nerd Fonts usage or want to share some information with the community, please go to one of the following places: