Merge pull request #55 from harmw/set-output

feat: expose results of hadolint to env var

.github/workflows/ci.yml

@@ -71,11 +71,16 @@ jobs:
 
       - name: Run integration test 5 - output format
         # This step will never fail, but will print out rule violations.
+        id: hadolint5
         uses: ./
         with:
           dockerfile: testdata/warning.Dockerfile
           config: testdata/hadolint.yaml
 
+      - name: Run integration test 6 - verify results output parameter
+        # This step will never fail, but will print out the results from step5
+        run: echo "${{ steps.hadolint5.outputs.results }}"
+
       #- name: Run integration test 6 - output to file
       #  # This step will never fail, but will print out rule violations.
       #  uses: ./

Makefile

@@ -1,7 +1,7 @@
 
 IMAGE_NAME:=hadolint-action
 
-lint-dockerfile: ## Runs hadoint against application dockerfile
+lint-dockerfile: ## Runs hadolint against application dockerfile
 	@docker run --rm -v "$(PWD):/data" -w "/data" hadolint/hadolint hadolint Dockerfile
 
 lint-yaml: ## Lints yaml configurations
@@ -12,8 +12,8 @@ build: ## Builds the docker image
 
 test: build ## Runs a test in the image
 	@docker run -i --rm \
-  -v /var/run/docker.sock:/var/run/docker.sock \
+    -v /var/run/docker.sock:/var/run/docker.sock \
-  -v ${PWD}:/test zemanlx/container-structure-test:v1.8.0-alpine \
+    -v ${PWD}:/test zemanlx/container-structure-test:v1.8.0-alpine \
     test \
     --image $(IMAGE_NAME) \
     --config test/structure-tests.yaml

README.md

@@ -6,7 +6,6 @@
 [![License](https://img.shields.io/badge/License-MIT-yellow.svg?style=for-the-badge)](LICENSE)
 [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=for-the-badge)](http://commitizen.github.io/cz-cli/)
 [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=for-the-badge)](https://github.com/semantic-release/semantic-release?style=for-the-badge)
-
 [![GitHub Workflow Status](https://img.shields.io/github/workflow/status/hadolint/hadolint-action/CI?style=for-the-badge)](https://github.com/hadolint/hadolint-action/action)
 
 ## Usage
@@ -16,41 +15,57 @@ Add the following step to your workflow configuration:
 ```yml
 steps:
   - uses: actions/checkout@v2 
-  - uses: hadolint/hadolint-action@v1.6.0
+  - uses: hadolint/hadolint-action@v2.0.0
     with:
       dockerfile: Dockerfile
 ```
 
 ## Inputs
 
-| Name               | Description                               | Default          |
+| Name                 | Description                                                                                                                             | Default            |
-|------------------- |------------------------------------------ |----------------- |
+|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------|--------------------|
-| dockerfile         | The path to the Dockerfile to be tested   | ./Dockerfile     |
+| `dockerfile`         | The path to the Dockerfile to be tested                                                                                                 | `./Dockerfile`     |
-| recursive          | Search for specified dockerfile           | false            |
+| `recursive`          | Search for specified dockerfile </br> recursively, from the project root                                                                | `false`            |
-|                    | recursively, from the project root        |                  |
+| `config`             | Custom path to a Hadolint config file                                                                                                   | `./.hadolint.yaml` |
-| config             | Custom path to a Hadolint config file     | ./.hadolint.yaml |
+| `output-file`        | A sub-path where to save the </br> output as a file to                                                                                  |                    |
-| output-file        | A sub-path where to save the              |                  |
+| `no-color`           | Don't create colored output (`true`/`false`)                                                                                            |                    |
-|                    | output as a file to                       |                  |
+| `no-fail`            | Never fail the action (`true`/`false`)                                                                                                  |                    |
-| no-color           | Don't create colored output               |                  |
+| `verbose`            | Output more information (`true`/`false`)                                                                                                |                    |
-| no-fail            | Never fail the action                     |                  |
+| `format`             | The output format. One of [`tty` \| `json` \| </br> `checkstyle` \| `codeclimate` \| </br> `gitlab_codeclimate` \| `codacy` \| `sarif`] | `tty`              |
-| verbose            | Output more information                   |                  |
+| `failure-threshold`  | Rule severity threshold for pipeline </br> failure. One of [`error` \| `warning` \| </br>  `info` \| `style` \| `ignore`]               | `info`             |
-| format             | The output format. One of [tty \| json \| | tty              |
+| `override-error`     | Comma separated list of rules to treat with `error` severity                                                                            |                    |
-|                    | checkstyle \| codeclimate \|              |                  |
+| `override-warning`   | Comma separated list of rules to treat with `warning` severity                                                                          |                    |
-|                    | gitlab_codeclimate \| codacy \| sarif]    |                  |
+| `override-info`      | Comma separated list of rules to treat with `info` severity                                                                             |                    |
-| failure-threshold  | Rule severity threshold for pipeline      | info             |
+| `override-style`     | Comma separated list of rules to treat with `style` severity                                                                            |                    |
-|                    | failure. One of [error \| warning \|      |                  |
+| `ignore`             | Comma separated list of Hadolint rules to ignore.                                                                                       | <none>             |
-|                    | info \| style \| ignore]                  |                  |
+| `trusted-registries` | Comma separated list of urls of trusted registries                                                                                      |                    |
-| override-error     | List of rules to treat with 'error'       |                  |
+
-|                    | severity                                  |                  |
+## Output
-| override-warning   | List of rules to treat with 'warning'     |                  |
+
-|                    | severity                                  |                  |
+The Action will store results in an environment variable that can be used in other steps in a workflow.
-| override-info      | List of rules to treat with 'info'        |                  |
+
-|                    | severity                                  |                  |
+Example to create a comment in a PR:
-| override-style     | List of rules to treat with 'style'       |                  |
+
-|                    | severity                                  |                  |
+```
-| ignore             | Space separated list of Hadolint rules to | <none>           |
+- name: Update Pull Request
-|                    | ignore.                                   |                  |
+  uses: actions/github-script@v6
-| trusted-registries | List of urls of trusted registries        |                  |
+  if: github.event_name == 'pull_request'
+  with:
+    script: |
+      const output = `
+      #### Hadolint: \`${{ steps.hadolint.outcome }}\`
+      \`\`\`
+      ${process.env.HADOLINT_RESULTS}
+      \`\`\`
+      `;
+
+      github.rest.issues.createComment({
+        issue_number: context.issue.number,
+        owner: context.repo.owner,
+        repo: context.repo.repo,
+        body: output
+      })
+```
 
 ## Hadolint Configuration
 

hadolint.sh

@@ -23,26 +23,30 @@ if [ -z "$HADOLINT_TRUSTED_REGISTRIES" ]; then
   unset HADOLINT_TRUSTED_REGISTRIES;
 fi
 
-OUTPUT=
-if [ -n "$HADOLINT_OUTPUT" ]; then
-  if [ -f "$HADOLINT_OUTPUT" ]; then
-    HADOLINT_OUTPUT="$TMP_FOLDER/$HADOLINT_OUTPUT"
-  fi
-  OUTPUT=" | tee $HADOLINT_OUTPUT"
-fi
-
-FAILED=0
 if [ "$HADOLINT_RECURSIVE" = "true" ]; then
   shopt -s globstar
 
   filename="${!#}"
   flags="${@:1:$#-1}"
 
-  hadolint $HADOLINT_CONFIG $flags **/$filename $OUTPUT || FAILED=1
+  RESULTS=$(hadolint $HADOLINT_CONFIG $flags **/$filename)
 else
   # shellcheck disable=SC2086
-  hadolint $HADOLINT_CONFIG "$@" $OUTPUT || FAILED=1
+  RESULTS=$(hadolint $HADOLINT_CONFIG "$@")
 fi
+FAILED=$?
+
+if [ -n "$HADOLINT_OUTPUT" ]; then
+  if [ -f "$HADOLINT_OUTPUT" ]; then
+    HADOLINT_OUTPUT="$TMP_FOLDER/$HADOLINT_OUTPUT"
+  fi
+  echo "$RESULTS" > $HADOLINT_OUTPUT
+fi
+
+RESULTS="${RESULTS//$'\\n'/''}"
+echo "::set-output name=results::$RESULTS"
+
+{ echo "HADOLINT_RESULTS<<EOF"; echo "$RESULTS"; echo "EOF"; } >> $GITHUB_ENV
 
 [ -z "$HADOLINT_OUTPUT" ] || echo "Hadolint output saved to: $HADOLINT_OUTPUT"