Skip to content

Commit

Permalink
Docs: Remove explicit release tag in Docker image name (#5671)
Browse files Browse the repository at this point in the history
The documentation on running AiiDA in a Docker container was suggesting:

    docker pull aiidateam/aiida-core:|release|

Where `|release|` would be substituted with the current version of the
package that was being built. However, since the v2.0 release, we started
adding the `.post0` suffix to the version number in the `main` branch.
This means that the `latest` documentation branch, which builds directly
of the `main` branch would generate, for example, the instruction:

    docker pull aiidateam/aiida-core:2.0.4.post0

But this would of course fail as that version does not exist on Docker
hub. Instead, we can simply use the `latest` identifier:

    docker pull aiidateam/aiida-core:latest

Since the `latest` build of the documentation should reference the latest
code release, this should be normally be correct.
  • Loading branch information
pcolaianni authored Sep 28, 2022
1 parent 3416ba6 commit 52a40ff
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/source/intro/run_docker.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,13 @@ This image contains a fully pre-configured AiiDA environment which makes it part

.. parsed-literal::
$ docker pull aiidateam/aiida-core:\ |release|\
$ docker pull aiidateam/aiida-core:latest
Then start the container with:

.. parsed-literal::
$ docker run -d --name aiida-container aiidateam/aiida-core:\ |release|\
$ docker run -d --name aiida-container aiidateam/aiida-core:latest
You can use the following command to block until all services have started up:

Expand Down Expand Up @@ -88,7 +88,7 @@ This image contains a fully pre-configured AiiDA environment which makes it part

.. parsed-literal::
$ docker run -d --name aiida-container --mount source=my-data,target=/tmp/my_data aiidateam/aiida-core:\ |release|\
$ docker run -d --name aiida-container --mount source=my-data,target=/tmp/my_data aiidateam/aiida-core:latest
Starting the container with the above command, ensures that any data stored in the ``/tmp/my_data`` path within the container is stored in the ``my-data`` volume and therefore persists even if the container is removed.

Expand Down

0 comments on commit 52a40ff

Please sign in to comment.