Skip to content

Commit bf595ec

Browse files
committed
chore: update readme for github resource detector
Update README of GitHub Resource Detector to clarify the source of the data. Part Of #2055 Signed-off-by: maryliag <[email protected]>
1 parent 35e6607 commit bf595ec

File tree

1 file changed

+15
-0
lines changed
  • detectors/node/opentelemetry-resource-detector-github

1 file changed

+15
-0
lines changed

detectors/node/opentelemetry-resource-detector-github/README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,21 @@ async function run() {
3333
run()
3434
```
3535

36+
## Available detectors
37+
38+
### GitHub Detector
39+
40+
| Resource Attribute | Description |
41+
|--------------------|-----------------------------------------------------------|
42+
| github.actor | Value of Process Environment Variable `GITHUB_ACTOR` |
43+
| github.base_ref | Value of Process Environment Variable `GITHUB_BASE_REF` |
44+
| github.head_ref | Value of Process Environment Variable `GITHUB_HEAD_REF` |
45+
| github.ref | Value of Process Environment Variable `GITHUB_REF` |
46+
| github.run_id | Value of Process Environment Variable `GITHUB_RUN_ID` |
47+
| github.run_number | Value of Process Environment Variable `GITHUB_RUN_NUMBER` |
48+
| github.sha | Value of Process Environment Variable `GITHUB_SHA` |
49+
| github.workflow | Value of Process Environment Variable `GITHUB_WORKFLOW` |
50+
3651
## Useful links
3752

3853
- [GitHub Action Environment Variables](https://docs.github.com/en/free-pro-team@latest/actions/reference/environment-variables)

0 commit comments

Comments
 (0)