Skip to main content

Deploying the frontend to production

Notify the team

  1. Post a message into di-dev channel in the Data Infrastructure (DDaT) Team saying that you want to do a release and ask if there are any objections. If no objections, proceed with the following steps.

Tag your release and generate release notes

  1. View the current tag on the releases page in the Data Workspace Frontend repo
  • Make a note of the latest tag
  • Click on “Draft a new release”
  • Ensure the “Target” box shows main and in the unlikely even it does not change the target branch to main
  • Click on the Tag button to select tag and at the bottom of the dropdown you should see “Create new tag”
  • Click on “Create new tag” and enter the new tag using the guidance in the “How to format your release tag” section below then click the “Create” button
  • Click the “Generate release notes” button
  • Check the option “Set as the latest release”
  • Click “Publish release”

How to format your release Tag

Format v<year>.<month>.<day>

If there are multiple releases in one day, increment the tag alphabetically starting with b. For example v2024.01.19 then v2024.01.19.b, v2024.01.19.c and so on.

N.b. If you don’t want to tag your release using the Github UI you can do it via git cli like this

git tag -a v2024.01.19 -m v2024.01.19

git push origin v2024.01.19

Release tag to production

  1. Head over to aws and login to the data-infrastructure-prod account but clicking on the DatainfrastructureAdministrator role
  • Navigate to the CodeBuild aws service
  • Click on the jupyterhub-admin project
  • Click on “Start build with overrides”
  • Scroll down to the “Source version” box (it should initially be populated with “main”)
  • Replace the text in this box with the release tag in the correct format e.g. v2024.01.19
  • Scroll down on page to the bottom and click the orange “Start build” button to kick off the build
  • You can monitor the build to completion either on the page that you are redirected to or on the “jupyterhub-admin” project page (“jupyterhub-admin” in the breadcrumbs at the top of the page)

Post in the DW channel

Once the release is complete (new containers are up in ECS) you can then notify everyone in the “Data Workspace Team” channel in the “Data Workspace Teams” channel group in Microsoft Teams. Use the format below.

Data Workspace  has just been released

Whats changed?


For more details please see the release notes