Browse Source

CLDC-NONE: Document release process

pull/3084/head
Samuel Young 3 months ago
parent
commit
d9a7a3964f
  1. 2
      docs/adr/index.md
  2. 2
      docs/app_api.md
  3. 2
      docs/bulk_upload.md
  4. 2
      docs/csv_downloads.md
  5. 2
      docs/documentation_website.md
  6. 2
      docs/exports.md
  7. 2
      docs/form/index.md
  8. 2
      docs/monitoring.md
  9. 2
      docs/rake.md
  10. 36
      docs/release.md

2
docs/adr/index.md

@ -1,6 +1,6 @@
--- ---
has_children: true has_children: true
nav_order: 13 nav_order: 14
--- ---
# Architecture decisions # Architecture decisions

2
docs/app_api.md

@ -1,5 +1,5 @@
--- ---
nav_order: 8 nav_order: 9
--- ---
# Using the App API # Using the App API

2
docs/bulk_upload.md

@ -1,5 +1,5 @@
--- ---
nav_order: 11 nav_order: 13
--- ---
# Bulk Upload # Bulk Upload

2
docs/csv_downloads.md

@ -1,5 +1,5 @@
--- ---
nav_order: 10 nav_order: 11
--- ---
# CSV Downloads # CSV Downloads

2
docs/documentation_website.md

@ -1,5 +1,5 @@
--- ---
nav_order: 14 nav_order: 15
--- ---
# This documentation website # This documentation website

2
docs/exports.md

@ -1,5 +1,5 @@
--- ---
nav_order: 7 nav_order: 8
--- ---
# Exporting to CDS # Exporting to CDS

2
docs/form/index.md

@ -1,6 +1,6 @@
--- ---
has_children: true has_children: true
nav_order: 9 nav_order: 10
--- ---
# Generating forms # Generating forms

2
docs/monitoring.md

@ -1,5 +1,5 @@
--- ---
nav_order: 6 nav_order: 7
--- ---
# Logs and Debugging # Logs and Debugging

2
docs/rake.md

@ -1,5 +1,5 @@
--- ---
nav_order: 11 nav_order: 12
--- ---
# Running Rake Tasks # Running Rake Tasks

36
docs/release.md

@ -0,0 +1,36 @@
---
nav_order: 6
---
# Releasing CORE code
Getting code released on core has the following steps.
## Gaining PO approval
Once a PR is dev approved, send the review app link to the PO for them to review, moving the ticket to PO review on Jira. Do not yet merge into main.
## Merging to main
Once the ticket is PO approved, the PR can be merged into main. This will deploy the branch to the staging environment.
## Creating a release
This is managed through GitHub releases
### Creating a draft release
In the GitHub releases section, create a new release. Release notes can be auto generated. All new commits on main since last release will be released.
Create a new version tag with an incremented version number.
### Getting release approval
Copy paste the release notes in the team slack channel and get tech lead approval.
### Publish
Publishing the release will deploy to prod.
The release action copies the current staging images to prod. Ensure that when publishing the release, the last **staging deployment pipeline** has completed successfully.
Else, changes will not be deployed as expected.
Loading…
Cancel
Save