Skip to content

Commit d1476eb

Browse files
authored
Add notes on docker build command on windows (#4458)
Reference: #3276 Signed-off-by: Chin Yeung Li <tli@nexb.com>
1 parent c0ce98b commit d1476eb

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

docs/source/getting-started/install.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -286,6 +286,17 @@ Run the ``docker build`` source code checkout directory.::
286286
cd scancode-toolkit
287287
docker build --tag scancode-toolkit --tag scancode-toolkit:$(git describe --tags) .
288288

289+
.. note::
290+
291+
As ``$(git describe --tags)`` is a Unix-style command. If you are on
292+
windows, please run the ``git describe --tags`` separately to get the
293+
output, then manually insert that value into your Docker command.
294+
For instance, ::
295+
296+
C:\scancode-toolkit>git describe --tags
297+
v32.4.0
298+
C:\scancode-toolkit>docker build --tag scancode-toolkit --tag scancode-toolkit:v32.4.0 .
299+
289300

290301
Run using Docker
291302
^^^^^^^^^^^^^^^^

0 commit comments

Comments
 (0)