Skip to content

Commit

Permalink
Fixed dev guide production release list, new theme
Browse files Browse the repository at this point in the history
  • Loading branch information
Jay Moran committed Aug 22, 2022
1 parent 0c927fc commit 98a9d7e
Show file tree
Hide file tree
Showing 5 changed files with 17 additions and 16 deletions.
2 changes: 1 addition & 1 deletion .env
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
#!/bin/sh
# Docker production build environment
TAG=0.19a0
TAG=0.18a0
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -58,3 +58,4 @@ share/python-wheels/
.installed.cfg
*.egg
MANIFEST
.vscode
26 changes: 13 additions & 13 deletions docs/guides/developerGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -207,26 +207,26 @@ Release procedure:
2. **Push changes to github.** Merge the master branch into the `production` branch and push the changes to github.

3. **Build production docker images with `bash release/generate_production_release.sh`.** While in the prodution branch, build the production images and generate the user production .zip by running `bash release/generate_production_release.sh`. This will:
* Create local lab, machine, and dbmongo production docker images with the tag defined in the .env file
* Create the production .zip named `target/production/Aliro-${VERSION}.zip`
```
git checkout production
bash release/generate_production_release.sh
```
* Create local lab, machine, and dbmongo production docker images with the tag defined in the .env file
* Create the production .zip named `target/production/Aliro-${VERSION}.zip`
```
git checkout production
bash release/generate_production_release.sh
```

4. **Push docker images to DockerHub and tag the production git branch by running `deploy_production_release.sh`.** While in the produciton branch, run `bash release/deploy_production_release.sh`. This will:
* Push the production lab, machine and dbmongo production docker images to dockerHub
* Tag the production git branch with the version defined in `.env`
```
git checkout production
bash release/deploy_production_release.sh
```
* Push the production lab, machine and dbmongo production docker images to dockerHub
* Tag the production git branch with the version defined in `.env`
```
git checkout production
bash release/deploy_production_release.sh
```

5. **Test DockerHub images and production code.** Test that the production release works with the newly uploaded DockerHub images by navigating to the directory `target/production/Aliro-${VERSION}` and running `docker-compose up`. This should start an instance of Aliro that loads the newest images from DockerHub. Test that this works as expected. Check that in the enviromental variables section of the admin page, 'TAG' matches the current version.

6. **Create Github Release.** If the test is successful, create a github release using the github web interface. Base the release on the tagged production commit. Attach the file `target/production/Aliro-${VERSION}.zip` as an archive asset.

7. **Update the .env file in the master branch with the new dev version.** Update the `.env` file in the master branch with the next version number and the `a0` suffix (see [Pre-release versioning conventions](https://www.python.org/dev/peps/pep-0440/#pre-releases) and push the changes to git. For example, `0.14` was just released, the new dev tag should be `0.15a0`.
7. **Update the .env file in the master branch with the new dev version.** Update the `.env` file in the master branch with the next version number and the `a0` suffix (see [Pre-release versioning conventions](https://www.python.org/dev/peps/pep-0440/#pre-releases) and push the changes to git. For example, `0.18` was just released, the new dev tag should be `0.19a0`.

### Installing a production build
1. Download a production build from github
Expand Down
2 changes: 1 addition & 1 deletion docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
sphinx==4.5.0
sphinx-rtd-theme==1.0.0
piccolo_theme
environs==9.5.0
m2r2==0.3.2
2 changes: 1 addition & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'sphinx_rtd_theme'
html_theme = 'piccolo_theme'

# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
Expand Down

0 comments on commit 98a9d7e

Please sign in to comment.