Skip to content

Commit cf1d4ed

Browse files
authored
Add known issue about permission and similar works (#28)
2 parents ffc0ec1 + bea989e commit cf1d4ed

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

README.md

+20
Original file line numberDiff line numberDiff line change
@@ -58,10 +58,30 @@ You can set `GITHUB_API_URL` environment variable to use this action with GHES.
5858

5959
## Known issues
6060

61+
### In some cases, the workflow requires `actions:read' permission.
62+
63+
Sometimes the `actions:read' permission is needed in the workflow to fetch workflow jobs and steps. If you see the following error, you need to add the`actions:read' permission to your workflow.
64+
65+
```yaml
66+
jobs:
67+
build:
68+
permissions:
69+
actions: read
70+
runs-on: ubuntu-latest
71+
steps:
72+
- uses: Kesin11/actions-timeline@v0
73+
```
74+
6175
### 'Waiting for a runner' step is not supported < GHES v3.9
6276

6377
GET `workflow_job` API response does not contain `created_at` field in [GHES v3.8](https://docs.github.com/en/enterprise-server@3.8/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run), it is added from [GHES v3.9](https://docs.github.com/en/enterprise-server@3.9/rest/actions/workflow-jobs?apiVersion=2022-11-28). So it is not possible to calculate the elapsed time the runner is waiting for a job, `actions-timeline` inserts a dummy step instead.
6478

79+
# Similar works
80+
81+
- https://github.com/Kesin11/github_actions_otel_trace
82+
- https://github.com/inception-health/otel-export-trace-action
83+
- https://github.com/runforesight/workflow-telemetry-action
84+
6585
# DEVELOPMENT
6686

6787
## Setup

0 commit comments

Comments
 (0)