From 573aceda887d4dd2d3085d206cafb82702d75699 Mon Sep 17 00:00:00 2001 From: Samuel Young Date: Wed, 16 Jul 2025 18:12:04 +0100 Subject: [PATCH] fixup! CLDC-NONE: Document release process move this to the existing infrastructure section --- docs/adr/index.md | 2 +- docs/app_api.md | 2 +- docs/bulk_upload.md | 2 +- docs/csv_downloads.md | 2 +- docs/documentation_website.md | 2 +- docs/exports.md | 2 +- docs/form/index.md | 2 +- docs/infrastructure.md | 13 +++++++------ docs/monitoring.md | 2 +- docs/rake.md | 2 +- docs/release.md | 30 ------------------------------ 11 files changed, 16 insertions(+), 45 deletions(-) delete mode 100644 docs/release.md diff --git a/docs/adr/index.md b/docs/adr/index.md index b4ee4f8ce..2f26ec915 100644 --- a/docs/adr/index.md +++ b/docs/adr/index.md @@ -1,6 +1,6 @@ --- has_children: true -nav_order: 14 +nav_order: 13 --- # Architecture decisions diff --git a/docs/app_api.md b/docs/app_api.md index eb3a2c577..627be0ad7 100644 --- a/docs/app_api.md +++ b/docs/app_api.md @@ -1,5 +1,5 @@ --- -nav_order: 9 +nav_order: 8 --- # Using the App API diff --git a/docs/bulk_upload.md b/docs/bulk_upload.md index a904cf57d..b0a06c32a 100644 --- a/docs/bulk_upload.md +++ b/docs/bulk_upload.md @@ -1,5 +1,5 @@ --- -nav_order: 13 +nav_order: 11 --- # Bulk Upload diff --git a/docs/csv_downloads.md b/docs/csv_downloads.md index d544c57f5..7dd82fb34 100644 --- a/docs/csv_downloads.md +++ b/docs/csv_downloads.md @@ -1,5 +1,5 @@ --- -nav_order: 11 +nav_order: 10 --- # CSV Downloads diff --git a/docs/documentation_website.md b/docs/documentation_website.md index b306a6398..728038fc5 100644 --- a/docs/documentation_website.md +++ b/docs/documentation_website.md @@ -1,5 +1,5 @@ --- -nav_order: 15 +nav_order: 14 --- # This documentation website diff --git a/docs/exports.md b/docs/exports.md index a6e9c0b9d..a35d7632e 100644 --- a/docs/exports.md +++ b/docs/exports.md @@ -1,5 +1,5 @@ --- -nav_order: 8 +nav_order: 7 --- # Exporting to CDS diff --git a/docs/form/index.md b/docs/form/index.md index 4c6724b0c..ed21e3b10 100644 --- a/docs/form/index.md +++ b/docs/form/index.md @@ -1,6 +1,6 @@ --- has_children: true -nav_order: 10 +nav_order: 9 --- # Generating forms diff --git a/docs/infrastructure.md b/docs/infrastructure.md index 1d095b03f..fedf3cf96 100644 --- a/docs/infrastructure.md +++ b/docs/infrastructure.md @@ -57,7 +57,7 @@ Where to find the Infrastructure? The infrastructure is managed as code. In the terraform folder of the codebase, there will be dedicated sub-folders for each of the aforementioned environments, where all the infrastructure for them is defined. -## Deployment (Pipeline — Recommended) +## Production Deployment The application is set up so that it can be deployed via GitHub actions. We use Git tags to mark releases. The only pre-requisite is that your GitHub account is added to our team. @@ -66,12 +66,13 @@ To deploy you need to: 1. Determine [previous version](https://github.com/communitiesuk/submit-social-housing-lettings-and-sales-data/tags), such as `v0.1.1`. 2. Create a [new release](https://github.com/communitiesuk/submit-social-housing-lettings-and-sales-data/releases/new) with subsequent version (e.g., `v0.1.2`). On this page, create a new tag with that version and generate release notes. Save as draft. 3. Post release notes on Slack. -4. Publish release. -5. Monitor alerting, logging and Sentry. -6. Post success message on Slack. -7. Tag tickets as ‘Released’ and move tickets to done on JIRA. +4. Ensure that there are no other pipelines running on the repo right now. If a staging deployment is running, it must complete before you can deploy to production. +5. Publish release. This will trigger the deployment pipeline. +6. Monitor alerting, logging and Sentry. +7. Post success message on Slack. +8. Tag tickets as ‘Released’ and move tickets to done on JIRA. -## CI/CD +## Staging Deployment When a commit is made to `main` the following GitHub action jobs are triggered: diff --git a/docs/monitoring.md b/docs/monitoring.md index 705ccac34..7b25801f7 100644 --- a/docs/monitoring.md +++ b/docs/monitoring.md @@ -1,5 +1,5 @@ --- -nav_order: 7 +nav_order: 6 --- # Logs and Debugging diff --git a/docs/rake.md b/docs/rake.md index 15a0dc165..0fc28eb5c 100644 --- a/docs/rake.md +++ b/docs/rake.md @@ -1,5 +1,5 @@ --- -nav_order: 12 +nav_order: 11 --- # Running Rake Tasks diff --git a/docs/release.md b/docs/release.md deleted file mode 100644 index b860d993f..000000000 --- a/docs/release.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -nav_order: 6 ---- - -# Releasing CORE code - -Getting code released on core has the following steps. - -## Releasing to staging - -Merging a branch to `main` will trigger the staging deployment pipeline. - -## Releasing to prod - -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. - -Be sure to save the release as a draft until it is ready to be deployed. - -### 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.