Skip to content

Latest commit

 

History

History
48 lines (28 loc) · 2.62 KB

Deployments.md

File metadata and controls

48 lines (28 loc) · 2.62 KB
Raw

Deployments

Commits to main are automatically deployed to dev and staging environments.

Deployments to production are done manually through Jenkins where a Git tag can be used.

Deploying to production

  1. Post a message into the #data-hub-core-dev channel saying that you want to do a Data Hub frontend release and ask if there are any objections. If no objections, proceed with the following steps.

  2. Create a GIT tag git tag v<MAJOR>.<MINOR>.<PATCH>, e.g. v5.1.2 pointing to the latest main.

    Release type When to increase
    Major (1.0.0) When a change requires modifications to the infrastructure, e.g. NodeJS version upgrade.
    Minor (0.1.0) When a release contains at least one new feature.
    Patch (0.0.1) When a release contains only fixes.

You can use the GitHub comparison tool to figure out what changes have been made since the last release. You can find out the latest release tag number from here.

  1. Push the tag to the remote - git push origin v<VERSION_NUMBER>.

  2. Check that the tag worked by using the GitHub comparison tool again to compare main to the new tag. If done correctly, it should say "main and v<VERSION_NUMBER> are identical".

  3. Create a GH pre-release by clicking Draft a new release on the releases page.

The release title should be v<VERSION_NUMBER> and release notes can be created by clicking the Auto-generate release notes button.

Check that the release notes generated contain what you expect to be deployed to production.

  1. Go to Jenkins and click on Build with Parameters.

  2. Select production for the environment.

  3. Type the v<VERSION_NUMBER> created in step 2 into the Git_Commit text field.

  4. Press the Build button.

  5. After the Jenkins build has finished, go to Data Hub production and check that everything is working correctly.

  6. Change the GH pre-release to an actual release.

  7. Post the following message on the #data-hub slack channel, making sure to put the actual version number and link the release notes:

@here Data Hub Frontend v<VERSION_NUMBER> is now live!
For more information see the release notes.