Skip to content

Commit 65093a2

Browse files
Update README and example workflows to reference the correct GitHub Action repository name
1 parent be350df commit 65093a2

3 files changed

Lines changed: 16 additions & 8 deletions

File tree

README.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
Composite GitHub Action that runs [Cognitive Code Analysis](https://github.com/Phauthentic/cognitive-code-analysis) (`phpcca`) in pull-request workflows. Install via PHAR or Composer, analyse changed PHP files, and optionally publish Markdown PR comments, workflow annotations, artifacts, and SARIF uploads.
44

5+
**Repository:** [Phauthentic/cognitive-code-analysis-github-action](https://github.com/Phauthentic/cognitive-code-analysis-github-action)
6+
57
This repository is separate from the main `cognitive-code-analysis` package ([issue #29](https://github.com/Phauthentic/cognitive-code-analysis/issues/29)).
68

79
## Quick start
@@ -28,7 +30,7 @@ jobs:
2830
with:
2931
fetch-depth: 0
3032

31-
- uses: Phauthentic/cca-gh-action@v1
33+
- uses: Phauthentic/cognitive-code-analysis-github-action@v1
3234
with:
3335
install-mode: phar
3436
post-comment: true
@@ -85,7 +87,7 @@ permissions:
8587
Downloads `phpcca.phar` from [GitHub Releases](https://github.com/Phauthentic/cognitive-code-analysis/releases). No Composer install step required in your workflow.
8688

8789
```yaml
88-
- uses: Phauthentic/cca-gh-action@v1
90+
- uses: Phauthentic/cognitive-code-analysis-github-action@v1
8991
with:
9092
install-mode: phar
9193
phar-version: '1.11.0'
@@ -103,7 +105,7 @@ Install dependencies first, then point the action at your binary:
103105
104106
- run: composer install --prefer-dist --no-ansi --no-interaction --no-progress
105107
106-
- uses: Phauthentic/cca-gh-action@v1
108+
- uses: Phauthentic/cognitive-code-analysis-github-action@v1
107109
with:
108110
install-mode: composer
109111
composer-command: vendor/bin/phpcca
@@ -128,16 +130,22 @@ See [`examples/minimal.yml`](examples/minimal.yml) for a PHAR workflow with PR c
128130

129131
### Local / path reference
130132

131-
Test the action from a branch before publishing:
133+
Pin a stable release (recommended):
134+
135+
```yaml
136+
- uses: Phauthentic/cognitive-code-analysis-github-action@v1
137+
```
138+
139+
Test the action from the default branch before a release:
132140

133141
```yaml
134-
- uses: Phauthentic/cca-gh-action@main
142+
- uses: Phauthentic/cognitive-code-analysis-github-action@master
135143
```
136144

137145
Or reference a checkout of this repo:
138146

139147
```yaml
140-
- uses: ./path/to/cca-gh-actions
148+
- uses: ./path/to/cognitive-code-analysis-github-action
141149
with:
142150
analyze-changed-files-only: 'false'
143151
paths: src/

examples/full-featured.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ jobs:
1818
with:
1919
fetch-depth: 0
2020

21-
- uses: Phauthentic/cca-gh-action@v1
21+
- uses: Phauthentic/cognitive-code-analysis-github-action@v1
2222
with:
2323
install-mode: phar
2424
phar-version: '1.11.0'

examples/minimal.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ jobs:
1717
with:
1818
fetch-depth: 0
1919

20-
- uses: Phauthentic/cca-gh-action@v1
20+
- uses: Phauthentic/cognitive-code-analysis-github-action@v1
2121
with:
2222
install-mode: phar
2323
post-comment: true

0 commit comments

Comments
 (0)