Skip to content

Commit

Permalink
docs: feature pinact (#228)
Browse files Browse the repository at this point in the history
* docs: feature pinact

https://github.com/suzuki-shunsuke/pinact

* chore: release to scoop

* docs: update README
  • Loading branch information
suzuki-shunsuke authored Nov 17, 2023
1 parent 81c33b7 commit 9430d6c
Show file tree
Hide file tree
Showing 3 changed files with 37 additions and 10 deletions.
9 changes: 9 additions & 0 deletions .goreleaser.yml
Original file line number Diff line number Diff line change
Expand Up @@ -76,3 +76,12 @@ brews:
# Default is empty.
test: |
system "#{bin}/ghalint --version"
scoops:
- description: GitHub Actions linter for security best practices.
license: MIT
skip_upload: auto
repository:
owner: suzuki-shunsuke
name: scoop-bucket
token: "{{ .Env.HOMEBREW_TAP_GITHUB_TOKEN }}"
32 changes: 22 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,31 @@ GitHub Actions linter for security best practices.

## How to install

- [Download a pre-built binary from GitHub Releases](https://github.com/suzuki-shunsuke/ghalint/releases) and locate an executable binary `ghalint` in `PATH`
- Homebrew: `brew install suzuki-shunsuke/ghalint/ghalint`
- [aqua](https://aquaproj.github.io/): `aqua g -i suzuki-shunsuke/ghalint`
1. Homebrew:

```sh
brew install suzuki-shunsuke/ghalint/ghalint
```

2. [Scoop](https://scoop.sh/)

```sh
scoop bucket add suzuki-shunsuke https://github.com/suzuki-shunsuke/scoop-bucket
scoop install ghalint
```

3. [aqua](https://aquaproj.github.io/)

```sh
aqua g -i suzuki-shunsuke/ghalint
```

4. [Download a pre-built binary from GitHub Releases](https://github.com/suzuki-shunsuke/ghalint/releases) and locate an executable binary `ghalint` in `PATH`

## How to use

```console
$ ghalint run
```sh
ghalint run
```

```console
Expand Down Expand Up @@ -78,11 +95,6 @@ ghalint reads GitHub Actions Workflows `^\.github/workflows/.*\.ya?ml$` and vali
If there are violatation ghalint outputs error logs and fails.
If there is no violation ghalint succeeds.

## Why not `actionlint`?

We develop `ghalint` to support our policies that [actionlint](https://github.com/rhysd/actionlint) doesn't cover.
We don't aim to replace actionlint to ghalint. We use both `actionlint` and `ghalint`.

## LICENSE

[MIT](LICENSE)
6 changes: 6 additions & 0 deletions docs/policies/008.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,3 +40,9 @@ excludes:
```
`policy_name` and `action_name` are mandatory.

## pinact

https://github.com/suzuki-shunsuke/pinact

[pinact](https://github.com/suzuki-shunsuke/pinact) is useful to convert tags to full length commit SHA.

0 comments on commit 9430d6c

Please sign in to comment.