Skip to content
This repository was archived by the owner on Dec 9, 2022. It is now read-only.

Commit a23d891

Browse files
author
Patrick Poetz
committed
updated README.md
1 parent 135f213 commit a23d891

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,9 @@ Where:
2626
- `Image_Name` is provided by the user as an input.
2727
- `IMAGE_TAG` is either the first 12 characters of the GitHub commit SHA or the value of INPUT_IMAGE_TAG env variable
2828

29+
Additionally it will use Git Tags pointing to the HEAD commit to create docker tags accordingly.
30+
E.g. Git Tag v1.1 will result in an additional docker tag v1.1.
31+
2932
## Usage
3033

3134

@@ -52,6 +55,7 @@ jobs:
5255
USERNAME: ${{ secrets.DOCKER_USERNAME }}
5356
PASSWORD: ${{ secrets.DOCKER_PASSWORD }}
5457
IMAGE_NAME: 'test-docker-action'
58+
IMAGE_TAG: 'v0.0'
5559
DOCKERFILE_PATH: 'argo/gpu.Dockerfile'
5660
BUILD_CONTEXT: 'argo/'
5761

@@ -68,8 +72,8 @@ jobs:
6872
6973
### Mandatory Inputs
7074
71-
1. `USERNAME` the login username, most likely your github handle. This username must have write access to the repo where the action is called.
72-
2. `PASSWORD` Your GitHub password that has write access to the repo where this action is called.
75+
1. `USERNAME` the login username, most likely your github handle. This username must have write access to the repo where the action is called. `x-access-token` should suffice.
76+
2. `PASSWORD` Your GitHub password that has write access to the repo where this action is called. `${{ secrets.GITHUB_TOKEN }}` should suffice.
7377
3. `IMAGE_NAME` is the name of the image you would like to push
7478
4. `DOCKERFILE_PATH`: The full path (including the filename) relative to the root of the repository that contains the Dockerfile that specifies your build.
7579
5. `BUILD_CONTEXT`: The directory for the build context. See these [docs](https://docs.docker.com/engine/reference/commandline/build/) for more information on the definition of build context.

0 commit comments

Comments
 (0)