Create a token for all repositories in the current owner's installation
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 72/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Quiet
- Tech stack
- github-actions, javascript
- Domain
- documentation
Research direction
Start with the linked documentation section, “Create a token for all repositories in the current owner's installation,” and review the descriptions of the owner and repositories properties. Update the wording to distinguish an explicitly set owner from the default current repository owner, then verify that the documented access scopes match the examples and reported behavior.
Written by the indexing model from the issue text.
Description
The docs currently have a section called Create a token for all repositories in the current owner's installation. It comes with a clean example:
on: [workflow_dispatch]
jobs:
hello-world:
runs-on: ubuntu-latest
steps:
- uses: actions/create-github-app-token@v3
id: app-token
with:
client-id: ${{ vars.APP_CLIENT_ID }}
private-key: ${{ secrets.APP_PRIVATE_KEY }}
owner: ${{ github.repository_owner }}
- uses: peter-evans/create-or-update-comment@v4
with:
token: ${{ steps.app-token.outputs.token }}
issue-number: ${{ github.event.issue.number }}
body: "Hello, World!"
I find the documentation of the owner and repositories properties a bit misleading though.
owner
Optional: The owner of the GitHub App installation. If empty, defaults to the current repository owner.
To me this means if I don't set owner explicitly, owner will be set to "the current repository owner". I conclude that if my repository lives under my org example-org/my-repo, I expect owner to be set to example-org.
repositories
Optional: Comma or newline-separated list of repositories to grant access to.
Note
If owner is set and repositories is empty, access will be scoped to all repositories in the provided repository owner's installation. If owner and >repositories are empty, access will be scoped to only the current repository.
"If owner is set".
According to my tests, owner does not count as set when left empty, even though owner property description says it automatically falls back to the repositories owner.
Suggestion, change wording in docs to:
If owner is set explicitly and repositories is empty, access will be scoped to all repositories in the provided repository owner's installation. If owner and repositories are empty, access will be scoped to only the current repository.
- Dominant language
- JavaScript
- Stars
- 886
- Forks
- 174
- PR merge metrics
- No merged PRs in 30d
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from actions/create-github-app-token
-
Difficulty 3/5 1-2 days Newbie friendliness 48/100
-
stale
Difficulty 3/5 1-2 days Newbie friendliness 55/100
actions/create-github-app-token#330 · 1 comment · 3 reactions ·
-
stale
Difficulty 3/5 1-2 days Newbie friendliness 65/100
actions/create-github-app-token#324 · 1 comment · 3 reactions ·
-
Difficulty 3/5 1-2 days Newbie friendliness 64/100
actions/create-github-app-token#322 · 1 comment · 4 reactions ·
-
Difficulty 4/5 3-5 days Newbie friendliness 38/100
actions/create-github-app-token#314 · 4 comments · 1 reaction ·
All issues in actions/create-github-app-token
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
HarperFast/skills#96 ·
-
[Block] Latest Posts [Type] Bug
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Automattic/studio#4908 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
sugarlabs/musicblocks#8847 ·