Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,12 @@ Other install paths:

- GitHub Releases: tagged archives for direct download
- Homebrew: `brew install devr-tools/tap/codeguard`
- GitHub Marketplace Action: `Devr Codeguard`

```yaml
- name: Devr Codeguard
uses: devr-tools/codeguard@v0.2.0
```

Or run in Docker:

Expand Down
7 changes: 7 additions & 0 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,13 @@ Or from this repository:
make build
```

Or in GitHub Actions from GitHub Marketplace:

```yaml
- name: Devr Codeguard
uses: devr-tools/codeguard@v0.2.0
```

For SDK consumers:

```bash
Expand Down
12 changes: 6 additions & 6 deletions docs/integrations.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
```yaml
repos:
- repo: https://github.com/devr-tools/codeguard
rev: v0.1.0
rev: v0.2.0
hooks:
- id: codeguard
args: ["-config", "codeguard.yaml", "-profile", "startup"]
Expand All @@ -17,11 +17,11 @@ The packaged hook runs `codeguard scan -mode diff -base-ref HEAD` by default.

## GitHub Action

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

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

```yaml
- name: CodeGuard
uses: devr-tools/codeguard@v0.1.0
- name: Devr Codeguard
uses: devr-tools/codeguard@v0.2.0
with:
config: codeguard.yaml
mode: diff
Expand Down
Loading