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

Releases are created through the Github release interface. To make one go here. Select Choose a new tag and type the version of the release. The release version should look like v{major}.{minor}.{patch}. See here if you're unsure on what the release version should be.

Change the "previous release" setting to the previous release (auto doesn't seem to work very well), and click on Generate release notes. This will create a starting set of release notes based on PR titles since the last release. 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.

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 Artemis, 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_artemis.py script will deploy the latest Artemis version to a specified beamline you can run it from your Artemis dev environment with e.g.

source .venv/bin/activate
python deploy_artemis --beamline i03

If you want to test the script you can run:

source .venv/bin/activate
python deploy_artemis --beamline dev

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