Skip to content

Commit

Permalink
Reflect its new location in the documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
chungyc committed Apr 5, 2023
1 parent 23e867a commit 808e8cc
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 6 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,11 @@ and uploads its suggested improvements to [GitHub code scanning].
This needs HLint to be set up.
This can be taken care of by [haskell/actions/hlint-setup].

**Warning**: This depends on unreleased versions of HLint,
and the location of this action will likely change in the future.
Neither has the action itself been officially released.
## Warning

This depends on unreleased versions of HLint.
For an example as to how one could use this action at the current time,
see [chungyc/site-personal/hlint.yaml](https://github.com/chungyc/site-personal/blob/main/.github/workflows/hlint.yaml).

## Usage

Expand All @@ -28,8 +30,10 @@ jobs:
security-events: write
steps:
- uses: actions/checkout@v3
# This step will not work yet.
# See the warning in the previous section.
- uses: haskell/actions/hlint-setup@v2
- uses: chungyc/hlint-scan@main
- uses: haskell-actions/hlint-scan@v0
```
### Inputs
Expand Down
2 changes: 1 addition & 1 deletion action.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ runs:

- name: Run HLint
run: |
"$BINARY" --no-exit-code --sarif "$FILEPATH" >> $TMPDIR/hlint.sarif
"$BINARY" --no-exit-code --sarif "$FILEPATH" >> "$TMPDIR/hlint.sarif"
shell: bash
env:
BINARY: ${{ inputs.binary }}
Expand Down
2 changes: 1 addition & 1 deletion docs/SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ affected versions, and, if known, mitigations for the issue. Our vulnerability
management team will respond within 7 working days of your report. This project
follows a 90 day disclosure timeline.

[file]: https://github.com/chungyc/hlint-scan/issues
[file]: https://github.com/haskell-actions/hlint-scan/issues

0 comments on commit 808e8cc

Please sign in to comment.