status-im
/
safe-react
mirror of https://github.com/status-im/safe-react.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update the readme about the release procedure (#2402) 

* Update the readme about the release procedure

* readme.md -> README.md

* Move the release docs
This commit is contained in:
katspaugh 2021-06-08 11:27:49 +02:00 committed by GitHub
parent 29ebf6667e
commit 6ae5166658
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 27 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
readme.md → README.md
View File

@ -82,21 +82,14 @@ yarn lint:fix
## Deployment
### Dev & staging
The code is deployed to a testing website automatically on each push via a GitHub Action.
The GitHub Action will create a new subdomain and post the link as a comment in the PR.
When pushing to the `master` branch, the code will be uploaded to the production bucket but not deployed automatically.
This is done manually by the devops team for extra safety.
When pushing to the `master` branch, the code will be automatically deployed to [staging](https://safe-team-rinkeby.staging.gnosisdev.com/).
## Releasing to production
We prepare a new release every sprint. Sprints are two weeks long.
* A separate code-freeze branch named `release/X.Y.Z` is created
* The QA team do regression testing on this branch
* If issues are found, bugfixes are merged into this branch
* Once the QA is done, we push the branch to `master` (which is deployed to production)
* Master is afterwards backmerged into the main `development` branch.
### Production
Deployment to production is done manually. Please see the [release procedure](docs/release-procedure.md) notes for details.
## Configuring the app for running on different networks

23
docs/release-procedure.md Normal file
View File

@ -0,0 +1,23 @@
# Releasing to production
We prepare at least one release every sprint. Sprints are two weeks long.
### Prepare a branch
* A code-freeze branch named `release/X.Y.Z` is created
* A commit that bumps the version in the `package.json` is made
### QA
* The QA team do regression testing on this branch
* If issues are found, bugfixes are merged into this branch
* Once the QA is done, we push the branch to `master`
* Master is automatically deployed to staging – some extra QA can be done there if needed
### Tag & release
* A version tag must be created and pushed.
```
git tag v3.7.0
git push --tags
```
* Devops are notified on Slack to deploy the tag to production
* A [GitHub release](https://github.com/gnosis/safe-react/releases) is created
* Master is back-merged into the main `development` branch