Skip to content

Commit 4834f9b

Browse files
author
Alan Christie
committed
docs: Add deployment notes to README
1 parent 0e4c544 commit 4834f9b

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,19 @@ For more information see:
2828
* [Informatics Matters website](https://www.informaticsmatters.com/pages/fragment_network.html)
2929
* [Fragnet Search application](https://fragnet.informaticsmatters.com/)
3030

31-
## Building (CI)
31+
## Building and deploying (CI)
3232
The project containers are built automatically using GitHub Actions
3333
(see the project workflows in `.github/workflows` for details of the build).
34-
`latest` images pushed to Docker Hub for each change on the
35-
master branch. Tagged releases are also automatically built and pushed to
36-
Docker hub, with `stable` images also produced when the release is _official_
37-
(i.e. of the form `N.N.N`).
34+
35+
- `latest` images pushed to Docker Hub for each change on the master branch.
36+
- Tagged releases are built and pushed to Docker hub, with `stable` images also
37+
produced when the release is _official_ (i.e. of the form `N.N[.N]`).
38+
39+
Deployment to the designated **staging** site is AUTOMATIC and occurs for every
40+
change to Master.
41+
42+
Deployment to the designated **production** site is AUTOMATIC and occurs for
43+
every _official_ tag (i.e. of the form `N.N[.N]`).
3844

3945
## Building (developer)
4046
Run the buildDockerImages target to build the container images `./gradlew buildDockerImages`.

0 commit comments

Comments
 (0)