Skip to content

Commit

Permalink
Updated the readme with build / tagging instructions. (#39)
Browse files Browse the repository at this point in the history
  • Loading branch information
jonn-smith authored May 4, 2021
1 parent 9c14809 commit 17f3f13
Showing 1 changed file with 29 additions and 2 deletions.
31 changes: 29 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,9 +55,9 @@ the following commands:

Note: If you run into "module not found" errors when running tox for testing, verify the modules are listed in test-requirements.txt and delete the .tox folder to force tox to refresh dependencies.

### Versioning
## Versioning

We use `bumpversion` to maintain version numbers.
We use `bumpversion` to maintain version numbers. It will automatically create a new tag every time you run it.
*DO NOT MANUALLY EDIT ANY VERSION NUMBERS.*

Our versions are specified by a 3 number semantic version system (https://semver.org/):
Expand All @@ -73,3 +73,30 @@ To update the version with bumpversion do the following:

This will increase the corresponding version number by 1.

You should always bump the version from the *main branch* _after_ merging in any PRs for that version. Then you will have to push both the bumpversion code update *AND* the tag that was created:

```
git push && git push --tags
```

## Releasing

The release process is as follows:

1. Bump the version by the appropriate PART (see *Versioning* for details).
2. Build and push the docker container (See *Docker*). NOTE: The version will have already been updated by using `bumpversion` in step 1.

## Docker

This repository includes a docker folder that contains a `Dockerfile` and a `Makefile`.
*DO NOT manually modify the Makefile or the Dockerfile* (unless you have to add dependencies). The version is automatically updated by `bumpversion`.

### Building

To build the docker image and push it to the release location do the following from the root of this repository:

```
cd docker
make build && make push
```

0 comments on commit 17f3f13

Please sign in to comment.