Skip to content

Commit 410f9a6

Browse files
committed
docs: update README with workflow instructions for APICURON reporting
1 parent 936b48c commit 410f9a6

File tree

1 file changed

+25
-1
lines changed

1 file changed

+25
-1
lines changed

README.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,28 @@ A GitHub Action that reports pushes to your repository to APICURON, associating
1111
- `REPORT_API_ENDPOINT`: APICURON report API URL
1212
- `REPORT_API_TOKEN`: APICURON API auth token
1313
- `USER_INFO_SERVICE_ENDPOINT`: ORCID lookup service URL
14-
- `USER_INFO_SERVICE_TOKEN`: ORCID service auth token
14+
- `USER_INFO_SERVICE_TOKEN`: ORCID service auth token
15+
2. **Create Workflow File**:
16+
`.github/workflows/apicuron-report.yml`
17+
```yaml
18+
name: APICURON Reporting
19+
on: [push]
20+
21+
jobs:
22+
report:
23+
runs-on: ubuntu-latest
24+
steps:
25+
- uses: actions/checkout@v4
26+
27+
- name: Submit to APICURON
28+
uses: ./.github/actions/apicuron-on-commit
29+
with:
30+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
31+
REPORT_API_ENDPOINT: ${{ secrets.REPORT_API_ENDPOINT }}
32+
REPORT_API_TOKEN: ${{ secrets.REPORT_API_TOKEN }}
33+
USER_INFO_SERVICE_ENDPOINT: ${{ secrets.USER_INFO_SERVICE_ENDPOINT }}
34+
USER_INFO_SERVICE_TOKEN: ${{ secrets.USER_INFO_SERVICE_TOKEN }}
35+
RESOURCE_ID: 'your-resource-id' # e.g., repository ID
36+
ACTIVITY_NAME: 'commit' # APICURON activity type
37+
LEAGUE: 'default' # APICURON league
38+

0 commit comments

Comments
 (0)