This repository has been archived by the owner on Sep 4, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 2
Git Flow
ntangy edited this page Jan 12, 2021
·
3 revisions
- All new work should be done in a new feature branch either in this repo or in a contributor's personal fork of this repo.
- When ready, the contributor should submit a PR from their feature branch (either in this repo or their fork) to the
develop
branch, which then must pass all checks - Another user should either approve the PR, reject the PR, or request changes
- Then, if the PR was approved, the contributor who submitted the PR should
- Merge the PR to the
develop
branch - Run
npm version <type> -m <description>
where<type>
is either "major", "minor", or "patch" and<description>
is a brief description of the changes in the release. This will bump the version in package.json, commit the change, and tag the commit with the version number and description - Push the new tag/commit to this repo with
git push origin develop --tags
- Create a PR from
develop
tomaster
- Merge the PR to
master
- Draft a new release in the Release tab in Github (with the 'v' prefix)
- Run
npm publish
on the newly updated master branch (EDIT 1/12/2021: A new Github Action workflow has been added for automatically runningnpm publish
after a new release has been created on Github. This step will not be needed unless the workflow fails)
- Merge the PR to the