Skip to content

Commit

Permalink
Update release process documentation (#2003)
Browse files Browse the repository at this point in the history
<!--
  1. New dependency? Is there an accompanying ADR?
2. New route? Is the code covered by functional (unit) and feature
(browser) tests?
3. New method/class? Have you documented your code using valid Yard
syntax?
  4. Do you need to update the CHANGELOG and add a PR ref?
-->

## Changes in this PR
- Added git fetch as a command for the process
- Documented how to find the docker image for the release log
<!--
  Succinct list of changes explaining what has changed and why.
-->

## Screen-shots or screen-capture of UI changes

<!--
  # Screen-shots
  - Include full page from header to footer, cropping the sides to fit.

  # Screen-captures
  - Record only the browser window
  - Don't full screen the browser window (to avoid large files)
- Break into separate videos if there are several journeys being
presented
  - Mac guide: https://support.apple.com/en-gb/HT208721
- Windows guide:
https://support.microsoft.com/en-us/windows/5328cd25-9046-4472-8a14-c485f138802c
-->
  • Loading branch information
serenaabbott11 authored Nov 27, 2024
2 parents de352f9 + 2d5c3cc commit 9b81b4c
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions doc/release-process.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ Production deployment is automated with github actions, but you will need to upd
Switch to the `production` branch, ensure it is updated from origin, then rebase it with `main`.

```
$ git fetch
$ git checkout main
$ git reset --hard origin/main
$ git checkout production
Expand All @@ -29,6 +30,8 @@ NOTE: `git push --force-with-lease` is important, the force push will be rejecte

Monitor the [github actions page](https://github.com/DFE-Digital/buy-for-your-school/actions/workflows/ci-full-pipeline.yml) to check status of the automated deployment.

After a successful deployment, you will need to update the release log [here](https://dfedigital.atlassian.net/wiki/spaces/GHBFS/pages/3535732763/Development+Release+log).
To get the docker image, find the latest version with the tag `production` on [the container registry page](https://github.com/DFE-Digital/buy-for-your-school/pkgs/container/buy-for-your-school).

## Staging

Expand All @@ -43,6 +46,7 @@ Development deployment is automated with github actions, but you will need to up
Switch to the `development` branch, ensure it is updated from origin, then rebase it with `main`.

```
$ git fetch
$ git checkout development
$ git reset --hard origin/development
$ git rebase your-feature-branch
Expand Down

0 comments on commit 9b81b4c

Please sign in to comment.