AlexsLemonade / AlexsLemonade/scpcaTools
Use docs-bot token for styling
- Dominant language
- R
- Stars
- 1
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
We have a couple of automated styling & docs actions implemented in https://github.com/AlexsLemonade/scpcaTools/blob/main/.github/workflows/pr-commands.yaml, but these use the default github token for authentication, which means that when they are run, they do not trigger any additional checks.
We should implement using the docs bot for git checkout and push in that workflow, which will then trigger downstream checks. To do this, we first need to give this repo access to the `OP_DOCS_BOT_GITHUB_TOKEN` secret, and then add a service account token that has access to that secret (presumably the scpca science team token).
This would be similar to:
https://github.com/AlexsLemonade/refinebio-examples/blob/61b5ae6fa35bdea95e966e6cdbf04ade8ada5605/.github/workflows/style-and-sp-check.yml#L23-L36
Contributor guide
Research direction
Start with .github/workflows/pr-commands.yaml and compare its checkout and push authentication with .github/workflows/style-and-sp-check.yml in refinebio-examples at lines 23-36. Confirm how this repository should access OP_DOCS_BOT_GITHUB_TOKEN and which service account token is appropriate. Done means styling and docs actions use the docs bot and trigger downstream checks.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- git, github-actions
- Domain
- ci-cd, security
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100