Skip to content

Commit 766f7d5

Browse files
committed
[NRL-662] Update the release process in the README
1 parent 0de267e commit 766f7d5

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

README.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -436,8 +436,6 @@ The `records` property is derived by first deploying to a specific environment,
436436

437437
## Sandbox
438438

439-
TODO-NOW Update sandbox notes
440-
441439
The public-facing sandbox is an additional persistent workspace (`int-sandbox`) deployed in our UAT (`int` / `test`) environment, alongside the persistent workspace named `ref`. It is identical to our live API, except it is open to the world via Apigee (which implements rate limiting on our behalf).
442440

443441
### Sandbox deployment
@@ -464,10 +462,15 @@ Additionally, and less importantly, there are also fixed organization details in
464462

465463
## Releases
466464

467-
TODO-NOW Update releases notes
468-
469-
When you create a release branch in the form of `release/yyyy-mm-dd` or `hotfix/yyyy-mm-dd` then you need to update the RELEASE file in the top level of the repository to match that release name
465+
The process to create a new release is as follows:
470466

471-
The CI pipeline will check to make sure you have done this to prevent any mistakes - if you have made a release or hotfix branch it will check that the value in the RELEASE file matches or not
467+
1. In [Github Releases](https://github.com/NHSDigital/NRLF/releases), press the "Draft new release" button.
468+
2. Press "Choose a tag" and enter the version of the release, say `v3.0.1`. This will be the tag we use to release from.
469+
3. Select `develop` for the release Target
470+
4. Press "Generate release notes" button. This will populate the description with everything that's changed since the last release.
471+
5. Enter the version of the release into the Release Title field, say `v3.0.1`
472+
6. Arrange and update the description to accuruately represent the highlights of the release.
473+
7. Make sure the "Set as the latest release" checkbox it set
474+
8. Press the "Publish release" button to complete the release process
472475

473-
This is because it will use that value to tag the commit once its been merged into main as a reference point, and this is how it tracks which release it is as github actions struggles with post merge branch identification
476+
Once your new release has been created, you can then deploy this release through the NRLF environments using the "Persistent Environment Deploy" Github Action.

0 commit comments

Comments
 (0)