Skip to content

Deploy new release for approval testing

When to use

When deploying a new release, for approval testing by DDF, on the staging project

Prerequisites

  • A local checkout of the dpl-platform repository
  • A running dplsh with DPLPLAT_ENV set to the platform environment name.
  • The version tag you want to deploy. This must correspond to a tagged version of the dpl-cms-source image.
  • The version tag of Go that you want to deploy. The version follows the cms version unless a Go hotfix is being released (see: "In case a Go hotfix is released").

In case a Go hotfix is released

In case of a Go hotfix it will be tagged as the current dpl-cms/go release with the last digit incremented.

So if the current cms/go release is called: 2025.26.0 the Go hotfix release would be tagged with: 2025.26.1.

Procedure: New release for approval testing

Use this procedure to deploy a new version for testing before it is released to production library sites.

  1. In your local environment ensure that your checkout of the main branch for dpl-platform is up to date.
  2. Create a new branch from main.
  3. Open infrastructure/environments/dplplat01/sites.yaml
  4. Set the value of dpl-cms-release and moduletest-dpl-cms-release for staging to the new version
  5. Set the value of moduletest-dpl-cms-release for bnf to the new version
  6. Set the value of go-release for to the new version. In case the go release is a hotfix: see "In case a Go hotfix is released"
  7. Commit the change and push your branch to GitHub and create a pull request.
  8. Request a review for the change and wait for approval.
  9. Start dplsh from the /infrastructure directory of your local environment by running ../tools/dplsh/dplsh.sh.
  10. Deploy the changes
  11. Run SITE=staging task site:sync
  12. Run SITE=bnf task site:sync
  13. Wait for the deployments for staging and bnf to complete using Lagoon UI
  14. If a deployment does not complete determine if the error relates to the platform or the application.
  15. If it is a platform-related error then try to redeploy the environment from the Lagoon UI.
  16. Merge the pull request once the deployment completes.

Procedure: A site fails to deploy

We have experience this quite a lot. We have gathered a list of known issues and how to solve them a troubleshoot runbook