Skip to content

Commit 7e7c95f

Browse files
committed
DOC: Add VERSION argument to docker build instructions
1 parent a6029ed commit 7e7c95f

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

docs/contributors.rst

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,12 @@ If it is necessary to rebuild the Docker image, a local image named
122122
``fmriprep`` may be built from within the working fmriprep
123123
repository, located in ``~/projects/fmriprep``: ::
124124

125-
~/projects/fmriprep$ docker build -t fmriprep .
125+
~/projects/fmriprep$ VERSION=$( python get_version.py )
126+
~/projects/fmriprep$ docker build -t fmriprep --build-arg VERSION=$VERSION .
127+
128+
The ``VERSION`` build argument is necessary to ensure that help text
129+
can be reliably generated. The ``get_version.py`` tool constructs the
130+
version string from the current repository state.
126131

127132
To work in this image, replace ``poldracklab/fmriprep:latest`` with
128133
``fmriprep`` in any of the above commands.
@@ -232,4 +237,4 @@ An example of how this works is shown here: ::
232237
(transformation matrices, and six corresponding rotation and translation
233238
parameters) are estimated before any spatiotemporal filtering using
234239
`mcflirt` [FSL {fsl_ver}, @mcflirt].
235-
""".format(fsl_ver=fsl.Info().version() or '<ver>')
240+
""".format(fsl_ver=fsl.Info().version() or '<ver>')

0 commit comments

Comments
 (0)