diff --git a/DEVELOPER_GUIDE.md b/DEVELOPER_GUIDE.md index aedb595f..54e6e605 100644 --- a/DEVELOPER_GUIDE.md +++ b/DEVELOPER_GUIDE.md @@ -3,15 +3,18 @@ To do a public release you need to... - Get the git directory ready for the release -- Tag the repo +- Tag the repo e.g. + +``` git tag -a v1.2.3 -m '' git push --tags +``` -- Generate the deploy templates +- Generate the deploy templates, don't add the `v` to the version number. +``` templates/generate-all deploy.zip 1.2.3 - - (Creates a deploy.zip file) Don't add 'v' to the version number +``` - Release @@ -21,20 +24,16 @@ To do a public release you need to... - At the bottom of the form, find the upload pad, click that and add the deploy.zip created earlier -- Create Python packages +- Create Python packages. You need a PyPi token with access to our repos - make packages - make pypi-upload - You need a PyPi token with access to our repos - -- Create containers +- Create containers. You need a docker hub token with acccess to our repos - make - make push - You need a docker hub token with acccess to our repos - To do a local build, you need to... - Consider what version you want to build at, and change this in Makefile. @@ -42,13 +41,20 @@ To do a local build, you need to... the public repos. You could stick with the version that's there, or change to 0.0.0 if you're paranoid about pushing something accidentally. -- If you changed the version to generate templates with your version +- If you changed the version to generate templates with your version, or + changed deployment templates, you need to recreate launch assets to + a deploy.zip file: +``` templates/generate-all deploy.zip V.V.V +``` -- make +- Build containers + +``` + make +``` - That builds containers. - If you changed anything which affects command line stuff (which maybe you could do if you changed schemas), then