Skip to content

Commit

Permalink
Usage example
Browse files Browse the repository at this point in the history
  • Loading branch information
ilteoood committed Jan 6, 2020
1 parent 2239cc4 commit 9880852
Showing 1 changed file with 20 additions and 1 deletion.
21 changes: 20 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,23 @@ The accepted inputs are:
| `publish` | Boolean | `false` | No | Indicate if the builded image should be published on Docker HUB |
| `platform` | String | `linux/amd64,linux/arm64,linux/arm/v7` | No | Platforms (*comma separated*) that should be used to build the image | |
| `dockerHubUser` | String | | Only if `publish` is true | User that will publish the image |
| `dockerHubPassword` | String | | Only if `publish` is true | Password of the `dockerHubUser` |
| `dockerHubPassword` | String | | Only if `publish` is true | Password of the `dockerHubUser` |

## Example of usage

```
jobs:
build:
runs-on: ubuntu-latest
name: Build image job
steps:
- name: Checkout master
uses: actions/checkout@master
- name: Build and publish image
uses: ilteoood/docker_buildx@master
with:
publish: true
imageName: YOUR_IMAGE_NAME_HERE
dockerHubUser: YOUR_USER_HERE
dockerHubPassword: YOUR_PASSWORD_HERE
```

0 comments on commit 9880852

Please sign in to comment.