From 11ebab6b7155ed608240a31461543ab49b2e0ea9 Mon Sep 17 00:00:00 2001 From: Alex Wilkerson John Date: Tue, 16 Jun 2026 13:17:44 -0400 Subject: [PATCH] save --- README.md | 6 ++++++ docs/getting-started.md | 7 +++++++ docs/integrations.md | 12 ++++++------ 3 files changed, 19 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 5503c28..62b18d2 100644 --- a/README.md +++ b/README.md @@ -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: diff --git a/docs/getting-started.md b/docs/getting-started.md index 20e7fa1..3ed8c18 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -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 diff --git a/docs/integrations.md b/docs/integrations.md index b02779d..c2c9654 100644 --- a/docs/integrations.md +++ b/docs/integrations.md @@ -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"] @@ -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 @@ -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