update docs for making releases
Follow these steps to make a release and new Docker image for Elpis.
-## Update version in the code
-
-Update the changelog and version details in the Elpis repo.
-
-```
-~/sandbox/elpis/CHANGELOG.md
-~/sandbox/elpis/pyproject.toml
-~/sandbox/elpis/docs/conf.py
-~/sandbox/elpis/elpis/gui/package.json
-```
-
-## Docs
+## Update docs
Update docs if required with any description of changed functionality. Pushing to master will rebuild the readthedocs repo.
@@ -46,37 +35,20 @@ docker run --rm --name elpis -p 5001:5001/tcp -p 6006:6006/tcp elpis-latest-test
Open [http://0.0.0.0:5001](http://0.0.0.0:5001) in a browser (or, try [http://localhost:5001](http://localhost:5001) if that doesn't work), and train and test with at least a [toy corpus](https://github.com/CoEDL/toy-corpora). For Kaldi, use the Abui toy corpus. The Na toy corpus may be more suitable for checking the HFT engine.
-If it's all good, retag the image with the CoEDL org and push it to the Docker Hub.
-```
-docker login
-docker tag elpis-latest-test coedl/elpis:latest
-docker tag elpis-latest-test coedl/elpis:0.xx.xx
-docker push coedl/elpis:latest
-docker push coedl/elpis:0.xx.xx
-```
-
-
-You can push all tags with this command. But don't do this if you have random dev tags.
-
-```
-docker push coedl/elpis
-```
+## Update the version number in the code
-Clean up Docker
+Update the changelog and version details in the Elpis code, and push a commit for the version bump to master (or make a PR).
```
-docker image rm elpis-latest-test
-docker image prune -a
+~/sandbox/elpis/CHANGELOG.md
+~/sandbox/elpis/pyproject.toml
+~/sandbox/elpis/docs/conf.py
+~/sandbox/elpis/elpis/gui/package.json
```
-## Push Git version commit
-
-Push a commit for the version bump.
-
-
## Make a Git release
* Draft a [new release](https://github.com/CoEDL/elpis/releases/new)
@@ -86,4 +58,23 @@ Push a commit for the version bump.
* Write a description of the release (should be the same as the changelog info).
* Click `Publish release`. This will bundle the code as `.zip` and `.tar.gz` assets with the release.
-done
+
+## Docker image
+
+Docker image builds are automatically triggered by any commit to master, which will build a Docker image tagged "latest". Version releases will build images tagged with the version number.
+
+The following commands can be used to build images with custom tags.
+
+```
+docker login
+docker tag elpis-latest-test coedl/elpis:custom-tag
+docker push coedl/elpis:custom-tag
+```
+
+Clean up Docker
+
+```
+docker image rm elpis-latest-test
+docker image prune -a
+```
+
