Skip to content

Commit

Permalink
docs: update deployment steps (#1947)
Browse files Browse the repository at this point in the history
Clarify the deployment steps and fix outdated links.
  • Loading branch information
patheard authored Oct 16, 2024
1 parent 3fe5a1f commit 690ac04
Showing 1 changed file with 12 additions and 19 deletions.
31 changes: 12 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# platform-mvp
# GC Articles

## Demo

Expand Down Expand Up @@ -312,24 +312,23 @@ phpcs ./wordpress/wp-content/plugins/cds-base/classes/Modules/Cleanup/Articles.p

**NOTE** You will need to have [GitHub CLI](https://cli.github.com) installed to complete the following steps

### 1) Bump the version #
### 1) Bump the version number

```bash
```sh
npm run update-version
```

This script will automatically update the [VERSION, theme and plugin files](https://github.com/cds-snc/platform-mvp-ircc/commit/d697a147499f36b2bff456d1be3d3a07e4e58711)
and create a PR titled `Version bump [version number]`
This script will automatically update the [VERSION, theme and plugin files](https://github.com/cds-snc/gc-articles/pull/1902) and create a PR titled `Version Bump [version number]`

### 2) Visit Github and review/merge the Version bump Pull Request that was created.
### 2) Visit Github and review/merge the Version bump PR that was created.

### 3) Create and tag a release

```bash
```sh
npm run tag-release
```

This step will prompt for release notes and will automatically update the [terragrunt.hcl](https://github.com/cds-snc/platform-mvp-ircc/blob/a5ca0d5688ce2ce224cc846772c7fcdf2b615fdc/infrastructure/terragrunt/env/prod/ecs/terragrunt.hcl#L63) file
This step will prompt for release notes and will automatically update the [environments.yml manifest file](https://github.com/cds-snc/gc-articles/blob/3fe5a1fe81a53d32c91fd86148092c27c86981a6/infrastructure/environments.yml)
and create a PR titled `Release [version number]`.

It will also create a tag and release on Github, and build and push Staging and Production containers tagged
Expand All @@ -338,31 +337,25 @@ with the version number to the container repositories for each environment.
**IMPORTANT**: The tagged (i.e. v1.x.x) container needs to finish building before the Release PR is merged.
You can check via the Github actions tab.

### 4) Visit Github and check the Release Pull Request that was created

The automated deployment will happen after this PR is merged.

You can run the following script to poll the staging environment to see when the container has been deployed:
### 4) Visit Github and merge the Release PR that was created.

```
npm run check-version
```
This will cause the tagged release to be deployed to `Staging`.

### Production deployment
### 5) Production deployment

You should always release to Staging first. The "tag-release" step above will build/tag/push both Staging and Production containers, so the Production deploy
is a simple config change.

When you're ready to deploy to Production, run the following command:

```
```sh
npm run deploy-production
```

This will first prompt you for the version you would like to deploy, and it will create a PR titled `Production release: [version number]` which simply
updates the deployed versions manifest.

Merging this PR will release the previously tagged container to Production.
:warning: Merging this PR will trigger a `Production` release.

### Production infrastructure deployment

Expand Down

0 comments on commit 690ac04

Please sign in to comment.