Skip to content

Commit

Permalink
Add a note how the Dockerfile can be used directly
Browse files Browse the repository at this point in the history
  • Loading branch information
mpdude committed Sep 24, 2019
1 parent f38d48b commit f426a43
Showing 1 changed file with 24 additions and 1 deletion.
25 changes: 24 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,30 @@ jobs:
uses: docker://webfactory/composer-require-checker:2.0.0
```
To pass a custom config file, add this:
This configuration will use the pre-built image at the Docker Hub. If you
feel more secure with building the Docker Image ad-hoc from the `Dockerfile`
in this repo, use the following syntax instead.

```diff
# .github/workflows/check.yml
on: [push]
name: Main
jobs:
composer-require-checker:
name: ComposerRequireChecker
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- name: ComposerRequireChecker
- uses: docker://webfactory/composer-require-checker:2.0.0
+ uses: webfactory/[email protected]
```

*Note:* When using the Docker image, the tag refers to the Docker image tag.
When referring to this repo, use a tag or commit hash for the Dockerfile.

In either case, to pass a custom config file, add this:

```diff
# .github/workflows/check.yml
on: [push]
Expand Down

0 comments on commit f426a43

Please sign in to comment.