Skip to content

Commit

Permalink
docs: improve the “preparing a release” steps
Browse files Browse the repository at this point in the history
  • Loading branch information
compojoom committed Jan 30, 2024
1 parent fa16a20 commit 6e2eea1
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions docs/release-procedure.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,12 @@ We prepare at least one release every sprint. Sprints are two weeks long.
* Bump the version in the `package.json`
* Create a PR with the list of changes

💡 To generate a quick changelog:
```
git log origin/main..origin/dev --pretty=format:'* %s'
```
> 💡 To generate a quick changelog:
> ```bash
> git log origin/main..origin/dev --pretty=format:'* %s'
> ```
* Add the PR to the Project `Web Squad` and set the status to `Ready for QA`
### QA
* The QA team do regression testing on this branch
Expand All @@ -47,7 +49,7 @@ git pull origin release/3.15.0
git push
```
A deploy workflow will kick in and do the following things:
A deployment workflow will kick in and do the following things:
* Deploy the code to staging
* Create a new git tag from the version in package.json
Expand Down

0 comments on commit 6e2eea1

Please sign in to comment.