Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: improve the “preparing a release” steps #3170

Merged
merged 1 commit into from
Jan 30, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Loading