Skip to content

Commit 5cc0e3e

Browse files
Update release docs (#1468)
1 parent 4443d66 commit 5cc0e3e

File tree

1 file changed

+51
-12
lines changed

1 file changed

+51
-12
lines changed

.github/README.md

+51-12
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,10 @@ It's also recommended to run Prettier automatically in your editor, e.g. using [
1313

1414
## Preparing Envs (e.g when the dev chain data is reset)
1515

16-
### Frontend
17-
18-
1. Create pools for initial data
19-
20-
### Faucet
16+
### Faucet (only available in demo and dev)
2117

2218
1. Add a valid seed hex to `faucet-api/env-vars/demo.secrets`
23-
2. Fund the account wallet with aUSD and DEVEL/DEMO
19+
2. Fund the account wallet with all availabe pool currencies and the native currency
2420

2521
### Onboarding API
2622

@@ -32,7 +28,7 @@ Setup pure proxy to sign transactions (whitelisting & transfer tokens).
3228
4. Add the pure_proxy_address to the env variable `MEMBERLIST_ADMIN_PURE_PROXY` in the onboarding api and `REACT_APP_MEMBERLIST_ADMIN_PURE_PROXY` in the centrifuge-app env variables.
3329
5. Make sure secure_wallet_B is funded with both aUSD and the Native currency.
3430

35-
Note: onboarding must be manually enabled for each tranche in the issuer settings.
31+
> onboarding must be manually enabled for each tranche in the issuer settings.
3632
3733
### Asset Originator POD Access
3834

@@ -107,14 +103,57 @@ To set a pool into maintenance mode, add the pool id to the environment variable
107103

108104
To make sure repository admins can control the full workflow of our apps to production safely this repository provides the following flow:
109105

110-
- When you open a PR a new cent-app will be deployed with your PR number on the URL such as: app-prXXX.k-f.dev
106+
- Opening a new PR will deploy cent-app using the PR number to app-prXXX.k-f.dev - There should be a comment with these links in your PR after deployment. Forks do not trigger a PR deployment
107+
108+
- Merging code into `main` will deploy buckets and functions pointing to: app-dev.k-f.dev
109+
110+
- Demo deployments must be [manually triggered](https://github.com/centrifuge/apps/actions/workflows/demo-deploys.yml). They are not required for the release process.
111+
112+
- Catalyst deployments are triggered by pushing a tag containing `rc` in the tag name.
111113

112-
- After code is merged to main you can see the changes in: app-dev.k-f.dev
114+
- Altair and staging are triggered by creating a `pre-release` [on the Github repository](https://github.com/centrifuge/apps/releases/new)
113115

114-
- When a repository admin creates a `centrifuge-app/v*` tag it will will trigger a deployment to [altair.centrifuge.io](https://altair.centrifuge.io). The release needs to FIRST be marked as `prerelease`.
116+
- Centrifuge is deployed by editing [an existing release](https://github.com/centrifuge/apps/releases) and unmarking `pre-release` to fully release it, it will promote the staging artifacts to app.centrifuge.io
115117

116-
> Draft releases or tags other than the one above will not trigger any deployments.
118+
- Using the github release manager the pre-release can be promoted to production ([app.centrifuge.io](https://app.centrifuge.io)) using the artifacts generated in the pre-release. The production release must be approved by a reviewer.
117119

118-
- Once ready, you can edit your pre-release and untick the "pre-release" setting to fully publish a release, this will trigger a refresh of our code in app.centrifuge.io and app.ipfs.centrifuge.io (coming soon)
120+
(Coming soon: release web-bundle to IPFS)
121+
122+
You can follow your deployments by going to [the Actions section](https://github.com/centrifuge/apps/actions/workflows/centrifuge-app.yml) of the github repo
123+
124+
HackMD docs: https://centrifuge.hackmd.io/MFsnRldyQSa4cadx11OtVg?view
125+
126+
## More info
119127

120128
More info on our release process rationale can be found in [our HackMD](https://centrifuge.hackmd.io/MFsnRldyQSa4cadx11OtVg?view) (Private link, only k-f contributors)
129+
130+
## Releasing to staging, Altair, and Prod/Centrifuge
131+
132+
### 1. Create a release and mark it as a pre-Release
133+
-> Deploys to pp.staging.centrifuge.io) and app.altair.centrifuge.io
134+
135+
Navigate to create a new [pre-release](https://github.com/centrifuge/apps/releases/new). Make sure to tick the `pre-release` option.
136+
137+
1. Use an existing tag `rc` created to release Catalyst or create a new `centrifuge-app-vX.YY` tag on the release screen. Only tags starting with `rc*` or `centrifuge-app-v*` will meet the requirements for deployments
138+
- Major version: release includes new features/improvments
139+
- Minor version: release only includes bug fixes
140+
2. Name the release `CentrifugeApp vX.X`
141+
3. Generate the release notes
142+
4. Tick the `Set as a pre-release` checkbox
143+
5. Click `Publish release` to trigger the build. You can follow progress on the [Actions dashboard](https://github.com/centrifuge/apps/actions/workflows/staging-deploy.yml)
144+
6. Once the build is complete, a reviewer must approve the release to trigger a deployment
145+
146+
When the deployment is finished a notification will be sent to the #eng-apps channel on Slack.
147+
148+
### 2. Create a production Release
149+
-> Deploys to app.centrifuge.io
150+
151+
> The deployment to staging from point 1. needs to have been finished first. The production deployment uses the artifacts generated in the pre-release.
152+
153+
Navigate to the [release summary](https://github.com/centrifuge/apps/releases) and select the pre-release you want to publish.
154+
155+
1. Untick the `Set as a pre-release` checkbox and then tick the `Set as the latest release` checkbox
156+
2. Click `Update release` to trigger the prod deployment. As with the pre-release, the production release must be approved by a reviewer.
157+
3. Follow your prod deployment in the [Actions dashboard](https://github.com/centrifuge/apps/actions/workflows/prod-deploy.yml)
158+
159+
When the deployment is finished a notification will be sent to the #eng-apps channel on Slack.

0 commit comments

Comments
 (0)