Skip to content

Commit 82820f3

Browse files
authored
Refine GitHub Action integration instructions
Updated the GitHub Action section to provide a more concise integration guide and removed unnecessary code snippets.
1 parent da7f6c9 commit 82820f3

1 file changed

Lines changed: 2 additions & 37 deletions

File tree

docs/usage.md

Lines changed: 2 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -67,24 +67,9 @@ poetry run rsmetacheck --input https://github.com/example/repo --config ./ci/rsm
6767

6868
## GitHub Action
6969

70-
You can integrate RSMetaCheck into your GitHub workflows:
70+
You can integrate RSMetaCheck into your GitHub workflow to test your own repository and detect issues automatically.
71+
Please refer to our action in the GitHub MarketPlace at [rsmetacheck actions](https://github.com/marketplace/actions/rsmetacheck) for more information.
7172

72-
```yaml
73-
name: RsMetaCheck
74-
75-
on: [push, pull_request]
76-
77-
jobs:
78-
check-metadata:
79-
runs-on: ubuntu-latest
80-
steps:
81-
- uses: actions/checkout@v4
82-
- uses: SoftwareUnderstanding/RsMetaCheck@v0.2.1
83-
with:
84-
verbose: "false"
85-
env:
86-
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
87-
```
8873

8974
## GitLab CI/CD
9075

@@ -109,23 +94,3 @@ rsmetacheck:
10994
11095
`$CI_PROJECT_URL` is a [built-in GitLab CI/CD variable](https://docs.gitlab.com/ee/ci/variables/predefined_variables.html) that automatically resolves to your repository's URL.
11196

112-
### Providing a GitHub Token (recommended)
113-
114-
SoMEF fetches repository metadata from GitHub's API. Without a token, anonymous requests are subject to low rate limits. To avoid this, store your GitHub personal access token as a [GitLab CI/CD variable](https://docs.gitlab.com/ee/ci/variables/) named `GITHUB_TOKEN` and pass it to `somef configure`:
115-
116-
```yaml
117-
rsmetacheck:
118-
image: python:3.11
119-
stage: test
120-
script:
121-
- pip install rsmetacheck
122-
- somef configure -a -t $GITHUB_TOKEN
123-
- rsmetacheck --input $CI_PROJECT_URL
124-
artifacts:
125-
paths:
126-
- pitfalls_outputs/
127-
- somef_outputs/
128-
- analysis_results.json
129-
when: always
130-
expire_in: 1 week
131-
```

0 commit comments

Comments
 (0)