Files
docker-run-action/README.md
Abdud Dayan Adeeb 9ad56b3196 multiline support
2020-06-17 21:00:26 -04:00

48 lines
1.2 KiB
Markdown

# Docker Run Action
This action targets a very specific use-case that is not currently supported by Github Workflows. This action gives you the capability to run built containers.
Docker already supports running commands inside a docker image. See [jobs.<jobs_id>.container](https://help.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idcontainer). But it doesn't give you a clean way to run an image from a private repo or an image built on a previous step.
### Example Usage
#### Standard use-case
```yaml
- uses: addnab/docker-run-action@v1
with:
image: docker:latest
run: echo "hello world"
```
#### Multiple commands
```yaml
- uses: addnab/docker-run-action@v1
with:
image: docker:latest
run: |
echo "first line"
echo "second line"
```
### Supported Inputs
```yaml
image:
description: 'Image'
required: true
options:
description: 'Options'
required: false
command:
description: 'Command'
required: false
registry:
description: 'Registry'
required: false
username:
description: 'Username'
required: false
password:
description: 'Password'
required: false
```