addnab/docker-run-action
1
0
Fork 0
mirror of https://github.com/addnab/docker-run-action.git synced 2025-01-14 00:27:58 +08:00
Code Issues Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Abdud Dayan Adeeb 2021-02-15 01:12:38 -05:00 committed by GitHub
parent e48328783a
commit 702ff8ec17
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
README.md
View File

@ -1,33 +1,25 @@
# Docker Run Action # Docker Run Action
Github Workflows already supports running on public docker images out-of-the-box (See [jobs.<jobs_id>.container](https://help.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idcontainer)). - run a privately-owned image.
- run an image built by a previous step.
- run a specific step in docker.
- See https://github.com/addnab/docker-run-action/blob/main/action.yml for all the available inputs.
### Then why use docker-run-action? #### Typical Use Case
- run on a privately-owned image.
- run on an image built by a previous step.
- run a specific step in docker
### Example Usage
#### single-line command
```yaml ```yaml
- uses: addnab/docker-run-action@v1 - uses: addnab/docker-run-action@v1
with: with:
image: docker:latest username: ${{ secrets.DOCKER_USERNAME }}
run: echo "hello world" password: ${{ secrets.DOCKER_PASSWORD }}
``` registry: gcr.io
image: private-image:latest
#### multi-line commands options: -v $GITHUB_WORKSPACE:/work -e ABC=123
```yaml
- uses: addnab/docker-run-action@v1
with:
image: docker:latest
run: | run: |
echo "first line" ./run-script
echo "second line"
``` ```
#### run on a privately-owned image #### run a privately-owned image
```yaml ```yaml
- uses: addnab/docker-run-action@v1 - uses: addnab/docker-run-action@v1
with: with:
@ -38,7 +30,7 @@ Github Workflows already supports running on public docker images out-of-the-box
run: echo "hello world" run: echo "hello world"
``` ```
#### run on an image built by a previous step #### run an image built by a previous step
```yaml ```yaml
- uses: docker/build-push-action@v1 - uses: docker/build-push-action@v1
with: with:
@ -62,13 +54,3 @@ Github Workflows already supports running on public docker images out-of-the-box
echo "first line" echo "first line"
echo "second line" echo "second line"
``` ```
#### use docker options
```yaml
- uses: addnab/docker-run-action@v1
with:
image: docker:latest
options: -v $GITHUB_WORKSPACE:/work -e ABC=123
run: |
echo "first line"
```