Creating a release and deploying it

Pre-release

Before a release you should run all the system tests on your local machine.

Creating a release

1. Make sure dodal has an up-to-date release by following the processes here.
2. Create a new branch from main named pre followed by the release version e.g. pre_v4.2.0. The release versions should look like v{major}.{minor}.{patch}. See here if you're unsure on what the release version should be.
3. Go here.
4. In the "Run workflow" dropdown, ensure "Use workflow from Branch: main" selected, and type the (non-pre) version of the release.
5. Run the workflow - this will pin dependency versions and create the full release tag
6. Go to the new release workflow.
7. Select the previously created full release version
8. Click on Generate release notes. This will create a starting set of release notes based on PR titles since the last release.
9. You should now manually go through each line on the release notes and read it from the perspective of a beamline scientist. It should be clear from each what the change means to the beamline and should have links to easily find further info.
10. Publish the release

Deciding release numbers

Releases should obviously be versioned higher than the previous latest release. Otherwise you should follow this guide:

• Major - Changes that will break compatibility between GDA and Hyperion, large code rewrites
• Minor - New features
• Patch - Bug fixes

Deploying a release

Remember to discuss any new deployments with the appropriate beamline scientist. The /deploy/deploy_hyperion.py script will deploy the latest Hyperion version to a specified beamline. Deployments live in /dls_sw/ixx/software/bluesky/hyperion_vXXX. To do a new deployment you should run the deploy script from your Hyperion dev environment with e.g.

python ./deploy/deploy_hyperion.py i03

If you want to test the script you can run:

python ./deploy/deploy_hyperion.py dev

and a released version will be put in /tmp/hyperion_release_test