Skip to content

Commit

Permalink
fix document
Browse files Browse the repository at this point in the history
  • Loading branch information
RyosukeDTomita committed Jun 17, 2024
1 parent 509e2a8 commit d39f7b7
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 2 deletions.
12 changes: 10 additions & 2 deletions doc/tools_doc/ghalint.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@

## ghalintとは

> [ghalintが検知してPolicy](https://github.com/suzuki-shunsuke/ghalint?tab=readme-ov-file#policies)
> [permissionsの一覧が載っているページ](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idpermissions)
---

## install
Expand All @@ -20,13 +18,16 @@ aqua g -i suzuki-shunsuke/ghalint@v0.2.11
ghalint run
```

- [ghalintが検知してPolicy](https://github.com/suzuki-shunsuke/ghalint?tab=readme-ov-file#policies)をみて修正する。

---

## 修正log

### All jobs should have the field permissions

- [内容](https://github.com/suzuki-shunsuke/ghalint/blob/main/docs/policies/001.md): すべてのjobにpermissionをつけないといけない。
- [permissionsの一覧が載っているページ](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idpermissions)を参照。

```yaml
jobs:
Expand All @@ -44,5 +45,12 @@ jobs:
### the step violates policies

- [内容](https://github.com/suzuki-shunsuke/ghalint/blob/main/docs/policies/008.md): フルコミットハッシュにすれば解決。
- [pinact](./pinact.md)を使うと簡単に修正できる。

### the job violates policies

imageにタグがついてなかったので修正。

```yaml
image: returntocorp/semgrep:sha-69df2e1
```
4 changes: 4 additions & 0 deletions doc/tools_doc/pinact.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,3 +42,7 @@ WARN[0000] get a reference error="GET https://api.github.com/repos/aquasecurity/
のような記載があり,GITHUB_TOKENをexportしているとそれを使ってpinactを起動しようとするらしい。
そのため,GITHUB_TOKENをunexportしたら解決。
### 422 No commit found for SHA
たまに,pinactがフルコミットハッシュを取得できないことがあるので手動でreleaseに関連付けられているコミットハッシュをurlから取得して記載することで[ghalint](./ghalint.md)のエラーを消せる。

0 comments on commit d39f7b7

Please sign in to comment.