Skip to content

Commit 0a7a2fc

Browse files
authored
docs(create-github-app-token): fix some errors in readme (#1558)
* fix(create-github-app-token): fix some errors in readme * Fix typo in permission_set parameter
1 parent c988ac9 commit 0a7a2fc

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

actions/create-github-app-token/README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,14 @@ From a `grafana/` org repository, get a ephemeral GitHub API token from a GitHub
77
| Name | Type | Description | Default Value | Required |
88
| ---------------- | ------ | --------------------------- | ------------- | -------- |
99
| `permission_set` | String | The required permission set | `default` | Yes |
10-
| `github-app` | String | The required GitHub app | | Yes |
10+
| `github_app` | String | The required GitHub app | | Yes |
1111
| `vault_instance` | String | Vault instance to point | `ops` | No |
1212

1313
## Outputs
1414

15-
| Name | Type | Description |
16-
| -------------- | ------ | -------------------------- |
17-
| `github_token` | String | The generated GitHub token |
15+
| Name | Type | Description |
16+
| ------- | ------ | -------------------------- |
17+
| `token` | String | The generated GitHub token |
1818

1919
## Examples
2020

@@ -49,7 +49,7 @@ jobs:
4949
run: |
5050
curl -L \
5151
-H "Accept: application/vnd.github+json" \
52-
-H "Authorization: Bearer ${{ steps.get-github-token.outputs.github_token }}" \
52+
-H "Authorization: Bearer ${{ steps.get-github-token.outputs.token }}" \
5353
-H "X-GitHub-Api-Version: 2022-11-28" \
5454
https://api.github.com/repos/grafana/grafana/assignees
5555
```
@@ -75,30 +75,30 @@ jobs:
7575
uses: grafana/shared-workflows/actions/create-github-app-token@create-github-app-token/v0.2.2
7676
with:
7777
github_app: github-app-name
78-
permissions-set: read-only-on-foo-repository
78+
permission_set: read-only-on-foo-repository
7979

8080
# Use the secrets
8181
- name: list issues assignees
8282
run: |
8383
curl -L \
8484
-H "Accept: application/vnd.github+json" \
85-
-H "Authorization: Bearer ${{ steps.get-github-token-read.outputs.github_token }}" \
85+
-H "Authorization: Bearer ${{ steps.get-github-token-read.outputs.token }}" \
8686
-H "X-GitHub-Api-Version: 2022-11-28" \
8787
https://api.github.com/repos/grafana/foo-repository/assignees
8888
8989
- id: get-github-token-write
9090
uses: grafana/shared-workflows/actions/create-github-app-token@create-github-app-token/v0.2.2
9191
with:
9292
github_app: github-app-name
93-
permissions-set: write-on-bar-repository
93+
permission_set: write-on-bar-repository
9494

9595
# Use the secrets
9696
- name: create a pull request
9797
run: |
9898
curl -L \
9999
-X POST \
100100
-H "Accept: application/vnd.github+json" \
101-
-H "Authorization: Bearer ${{ steps.get-github-token-write.outputs.github_token }}" \
101+
-H "Authorization: Bearer ${{ steps.get-github-token-write.outputs.token }}" \
102102
-H "X-GitHub-Api-Version: 2022-11-28" \
103103
https://api.github.com/repos/grafana/bar-repository/pulls \
104104
-d '{"title":"Amazing new feature","body":"Please pull these awesome changes in!","head":"octocat:new-feature","base":"master"}'

0 commit comments

Comments
 (0)