Skip to content

Commit 318a475

Browse files
authored
Update README.md (#1275)
1 parent 6920196 commit 318a475

File tree

1 file changed

+7
-20
lines changed

1 file changed

+7
-20
lines changed

README.md

Lines changed: 7 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -118,34 +118,21 @@ When you are ready for feedback:
118118
## Merge process
119119

120120
Once your pull request has been approved by all parties, you may begin the merge process:
121-
* Merge in the latest `master` and resolve any conflicts if needed.
121+
* Merge in the latest `main` and resolve any conflicts if needed.
122122
* Run `yarn lint` to ensure no new styling errors are returned.
123123
* Run `yarn test` to ensure tests are passing.
124124
* Click the Squash and merge button on your pull request and edit your commit message to a concise description of your changes.
125125

126126
## Release process
127127

128-
This repository follows the [git flow release process](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow).
129-
* Each new feature branch uses develop as its parent branch and is merged back into develop upon completion.
130-
* Each new hotfix branch uses main as its parent branch and is merged directly into main.
131-
132128
This package uses [Semantic versioning](https://semver.org/), which requires version numbers in MAJOR.MINOR.PATCH format. Any breaking changes to the API require an update to the MAJOR version. Backwards compatible changes only require an update to the MINOR version. Hotfixes and patches need only update the PATCH version.
133129

134-
To create a new release off of the current develop:
135-
* Run the "Prepare release" github action which will
136-
* Create a new release branch off of the latest develop and increment package.json
137-
* Create a pull request of the release branch against main
138-
* Create a pull request of the release branch against develop
139-
* From there the developer can merge the PRs via github
140-
* Run the "Create new release" github action which will build the project and create a new release off of the latest main
141-
142-
To create a patch release for a hotfix off the current main:
143-
* Run the "Prepare hotfix" github action which will
144-
* Create a hotfix off the latest main and increment package.json
145-
* Create a pull request of the hotfix branch against main
146-
* Create a pull request of the release branch against develop
147-
* From there the developer can merge the PRs via github
148-
* Run the "Create new release" github action which will build the project and create a new release off of the latest main
130+
To create a new release off of `main`:
131+
* Run the "Create new release" github action found under "Actions"
132+
* Click "Run workflow" and select the following:
133+
* Choose `main` as the branch
134+
* Select the version you want to release
135+
* This will build the project and create a new release off of the latest `main`
149136

150137
## Manual Release steps
151138

0 commit comments

Comments
 (0)