Skip to content

Commit 337f9ab

Browse files
authored
save (#4)
2 parents b4c7a17 + 11ebab6 commit 337f9ab

3 files changed

Lines changed: 19 additions & 6 deletions

File tree

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,12 @@ Other install paths:
3838

3939
- GitHub Releases: tagged archives for direct download
4040
- Homebrew: `brew install devr-tools/tap/codeguard`
41+
- GitHub Marketplace Action: `Devr Codeguard`
42+
43+
```yaml
44+
- name: Devr Codeguard
45+
uses: devr-tools/codeguard@v0.2.0
46+
```
4147
4248
Or run in Docker:
4349

docs/getting-started.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,13 @@ Or from this repository:
1414
make build
1515
```
1616

17+
Or in GitHub Actions from GitHub Marketplace:
18+
19+
```yaml
20+
- name: Devr Codeguard
21+
uses: devr-tools/codeguard@v0.2.0
22+
```
23+
1724
For SDK consumers:
1825
1926
```bash

docs/integrations.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
```yaml
88
repos:
99
- repo: https://github.com/devr-tools/codeguard
10-
rev: v0.1.0
10+
rev: v0.2.0
1111
hooks:
1212
- id: codeguard
1313
args: ["-config", "codeguard.yaml", "-profile", "startup"]
@@ -17,11 +17,11 @@ The packaged hook runs `codeguard scan -mode diff -base-ref HEAD` by default.
1717

1818
## GitHub Action
1919

20-
This repository also ships a composite action at `action.yml`:
20+
This repository also ships the GitHub Marketplace action `Devr Codeguard` from `action.yml`:
2121

2222
```yaml
23-
- name: CodeGuard
24-
uses: devr-tools/codeguard@v0.1.0
23+
- name: Devr Codeguard
24+
uses: devr-tools/codeguard@v0.2.0
2525
with:
2626
config: codeguard.yaml
2727
profile: strict
@@ -35,8 +35,8 @@ The action installs `github.com/devr-tools/codeguard/cmd/codeguard` and runs `co
3535
For pull request workflows, the action can also publish a sticky fix-oriented comment:
3636

3737
```yaml
38-
- name: CodeGuard
39-
uses: devr-tools/codeguard@v0.1.0
38+
- name: Devr Codeguard
39+
uses: devr-tools/codeguard@v0.2.0
4040
with:
4141
config: codeguard.yaml
4242
mode: diff

0 commit comments

Comments
 (0)