diff --git a/docs/adr/index.md b/docs/adr/index.md index 2f26ec915..b4ee4f8ce 100644 --- a/docs/adr/index.md +++ b/docs/adr/index.md @@ -1,6 +1,6 @@ --- has_children: true -nav_order: 13 +nav_order: 14 --- # Architecture decisions diff --git a/docs/app_api.md b/docs/app_api.md index 627be0ad7..eb3a2c577 100644 --- a/docs/app_api.md +++ b/docs/app_api.md @@ -1,5 +1,5 @@ --- -nav_order: 8 +nav_order: 9 --- # Using the App API diff --git a/docs/bulk_upload.md b/docs/bulk_upload.md index b0a06c32a..a904cf57d 100644 --- a/docs/bulk_upload.md +++ b/docs/bulk_upload.md @@ -1,5 +1,5 @@ --- -nav_order: 11 +nav_order: 13 --- # Bulk Upload diff --git a/docs/csv_downloads.md b/docs/csv_downloads.md index 7dd82fb34..d544c57f5 100644 --- a/docs/csv_downloads.md +++ b/docs/csv_downloads.md @@ -1,5 +1,5 @@ --- -nav_order: 10 +nav_order: 11 --- # CSV Downloads diff --git a/docs/documentation_website.md b/docs/documentation_website.md index 728038fc5..b306a6398 100644 --- a/docs/documentation_website.md +++ b/docs/documentation_website.md @@ -1,5 +1,5 @@ --- -nav_order: 14 +nav_order: 15 --- # This documentation website diff --git a/docs/exports.md b/docs/exports.md index a35d7632e..a6e9c0b9d 100644 --- a/docs/exports.md +++ b/docs/exports.md @@ -1,5 +1,5 @@ --- -nav_order: 7 +nav_order: 8 --- # Exporting to CDS diff --git a/docs/form/index.md b/docs/form/index.md index ed21e3b10..4c6724b0c 100644 --- a/docs/form/index.md +++ b/docs/form/index.md @@ -1,6 +1,6 @@ --- has_children: true -nav_order: 9 +nav_order: 10 --- # Generating forms diff --git a/docs/monitoring.md b/docs/monitoring.md index 7b25801f7..705ccac34 100644 --- a/docs/monitoring.md +++ b/docs/monitoring.md @@ -1,5 +1,5 @@ --- -nav_order: 6 +nav_order: 7 --- # Logs and Debugging diff --git a/docs/rake.md b/docs/rake.md index 0fc28eb5c..15a0dc165 100644 --- a/docs/rake.md +++ b/docs/rake.md @@ -1,5 +1,5 @@ --- -nav_order: 11 +nav_order: 12 --- # Running Rake Tasks diff --git a/docs/release.md b/docs/release.md new file mode 100644 index 000000000..c798c89a3 --- /dev/null +++ b/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.