This repository has been archived by the owner on May 31, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 67
Releases
Eleni Chappen edited this page Dec 16, 2022
·
6 revisions
Since we release our site changes as soon as they’re approved, we treat release notes more like Weekly Ships—they’re an announcement of what we’ve done recently.
Because we work in Github, we can take advantage of Github’s automated Release Notes features by tracking releases there.
We publish new release notes right after every sprint cycle.
We use semantic versioning for our release versions, which is formatted as v[MAJOR].[MINOR].[PATCH]
(example: v2.5.8
).
- MAJOR - uptick this number for redesigns or replatforming (rarest)
- MINOR - uptick this number for other changes, or releases containing both changes and bugfixes (most common)
- PATCH - uptick this number for bug fixes only
You must have admin rights to this repo in order to create new tags and publish new releases.
- Go to the methods releases page
- Click "Create a new release"
- Determine whether this sprint's work is a Major, Minor, or Patch release
- Under "Choose a tag", enter the new version number and select "Create new tag on publish" (example:
v2.5.9
). - Set Target as the
main
branch - Set the Release title as the new tag number (example:
v2.5.9
) - For release notes, click "Generate Release Notes"
- Refine and reorganize notes into Added, Updated, and Fixed headings
- Check box "Set as the latest release"
- Publish release