|
1 |
| -# action-template |
| 1 | +# GitHub Action: Run `docker build --check` with action-docker-build-check |
2 | 2 |
|
3 |
| -<!-- TODO: replace reviewdog/action-template with your repo name --> |
4 |
| -[](https://github.com/reviewdog/action-template/actions?query=workflow%3ATest) |
5 |
| -[](https://github.com/reviewdog/action-template/actions?query=workflow%3Areviewdog) |
6 |
| -[](https://github.com/reviewdog/action-template/actions?query=workflow%3Adepup) |
7 |
| -[](https://github.com/reviewdog/action-template/actions?query=workflow%3Arelease) |
8 |
| -[](https://github.com/reviewdog/action-template/releases) |
9 |
| -[](https://github.com/haya14busa/action-bumpr) |
| 3 | +This action runs `docker build --check` with reviewdog on pull requests to improve code review experience. |
10 | 4 |
|
11 |
| - |
12 |
| - |
| 5 | +## Examples |
13 | 6 |
|
14 |
| -This is a template repository for [reviewdog](https://github.com/reviewdog/reviewdog) action with release automation. |
15 |
| -Click `Use this template` button to create your reviewdog action :dog:! |
16 |
| - |
17 |
| -If you want to create your own reviewdog action from scratch without using this |
18 |
| -template, please check and copy release automation flow. |
19 |
| -It's important to manage release workflow and sync reviewdog version for all |
20 |
| -reviewdog actions. |
21 |
| - |
22 |
| -This repo contains a sample action to run [misspell](https://github.com/client9/misspell). |
23 |
| - |
24 |
| -## Input |
25 |
| - |
26 |
| -<!-- TODO: update --> |
27 |
| -```yaml |
28 |
| -inputs: |
29 |
| - github_token: |
30 |
| - description: 'GITHUB_TOKEN' |
31 |
| - default: '${{ github.token }}' |
32 |
| - workdir: |
33 |
| - description: 'Working directory relative to the root directory.' |
34 |
| - default: '.' |
35 |
| - ### Flags for reviewdog ### |
36 |
| - level: |
37 |
| - description: 'Report level for reviewdog [info,warning,error]' |
38 |
| - default: 'error' |
39 |
| - reporter: |
40 |
| - description: 'Reporter of reviewdog command [github-pr-check,github-check,github-pr-review].' |
41 |
| - default: 'github-pr-check' |
42 |
| - filter_mode: |
43 |
| - description: | |
44 |
| - Filtering mode for the reviewdog command [added,diff_context,file,nofilter]. |
45 |
| - Default is added. |
46 |
| - default: 'added' |
47 |
| - fail_on_error: |
48 |
| - description: | |
49 |
| - Exit code for reviewdog when errors are found [true,false] |
50 |
| - Default is `false`. |
51 |
| - default: 'false' |
52 |
| - reviewdog_flags: |
53 |
| - description: 'Additional reviewdog flags' |
54 |
| - default: '' |
55 |
| - ### Flags for <linter-name> ### |
56 |
| - locale: |
57 |
| - description: '-locale flag of misspell. (US/UK)' |
58 |
| - default: '' |
59 |
| -``` |
| 7 | + |
60 | 8 |
|
61 | 9 | ## Usage
|
62 |
| -<!-- TODO: update. replace `template` with the linter name --> |
63 | 10 |
|
64 | 11 | ```yaml
|
65 | 12 | name: reviewdog
|
66 | 13 | on: [pull_request]
|
67 | 14 | jobs:
|
68 |
| - # TODO: change `linter_name`. |
69 |
| - linter_name: |
70 |
| - name: runner / <linter-name> |
| 15 | + docker-build-check: |
| 16 | + name: docker-build-check |
71 | 17 | runs-on: ubuntu-latest
|
72 | 18 | steps:
|
73 | 19 | - uses: actions/checkout@v4
|
74 |
| - - uses: reviewdog/action-template@v1 |
| 20 | + - uses: shmokmt/action-docker-build-check@master |
75 | 21 | with:
|
76 | 22 | github_token: ${{ secrets.github_token }}
|
77 |
| - # Change reviewdog reporter if you need [github-pr-check,github-check,github-pr-review]. |
78 |
| - reporter: github-pr-review |
79 |
| - # Change reporter level if you need. |
80 |
| - # GitHub Status Check won't become failure with warning. |
81 |
| - level: warning |
82 | 23 | ```
|
83 | 24 |
|
84 |
| -## Development |
85 |
| -
|
86 |
| -### Release |
87 |
| -
|
88 |
| -#### [haya14busa/action-bumpr](https://github.com/haya14busa/action-bumpr) |
89 |
| -You can bump version on merging Pull Requests with specific labels (bump:major,bump:minor,bump:patch). |
90 |
| -Pushing tag manually by yourself also work. |
91 |
| -
|
92 |
| -#### [haya14busa/action-update-semver](https://github.com/haya14busa/action-update-semver) |
93 |
| -
|
94 |
| -This action updates major/minor release tags on a tag push. e.g. Update v1 and v1.2 tag when released v1.2.3. |
95 |
| -ref: https://help.github.com/en/articles/about-actions#versioning-your-action |
96 |
| -
|
97 |
| -### Lint - reviewdog integration |
98 |
| -
|
99 |
| -This reviewdog action template itself is integrated with reviewdog to run lints |
100 |
| -which is useful for Docker container based actions. |
101 |
| -
|
102 |
| - |
103 |
| -
|
104 |
| -Supported linters: |
105 |
| -
|
106 |
| -- [reviewdog/action-shellcheck](https://github.com/reviewdog/action-shellcheck) |
107 |
| -- [reviewdog/action-hadolint](https://github.com/reviewdog/action-hadolint) |
108 |
| -- [reviewdog/action-misspell](https://github.com/reviewdog/action-misspell) |
109 |
| -
|
110 |
| -### Dependencies Update Automation |
111 |
| -This repository uses [reviewdog/action-depup](https://github.com/reviewdog/action-depup) to update |
112 |
| -reviewdog version. |
113 |
| -
|
114 |
| -[](https://github.com/reviewdog/action-template/pull/6) |
| 25 | +## See Also |
| 26 | +* https://docs.docker.com/reference/build-checks/ |
0 commit comments