Docs: update cp-update workflow docs with gh app section #2293
Conversation
jackw
added
type/docs
github-project-automation
bot
moved this to 📬 Triage
in Plugins Platform / Grafana Community
|
Hello! 👋 This repository uses Auto for releasing packages using PR labels. ✨ This PR can be merged. It will not be considered when calculating future versions of the npm packages and will not appear in the changelogs. |
There was a problem hiding this comment.
Pull Request Overview
This PR adds documentation for using a GitHub App as an alternative authentication method for the cp-update workflow. The changes include an image showing required permissions for a Personal Access Token (PAT) and a new section explaining how to configure and use a GitHub App instead.
Key Changes
- Restructured authentication documentation to present two options: PAT and GitHub App
- Added an image demonstrating required PAT permissions
- Added a complete workflow example using GitHub App authentication
Reviewed Changes
Copilot reviewed 1 out of 2 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| docusaurus/website/static/img/cp-update-pat-permissions.png | New image showing required permissions for PAT setup |
| docusaurus/docs/set-up/set-up-github.md | Updated documentation with GitHub App section and restructured authentication options |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| This workflow requires `content`, `pull request` and `workflow` write access to your plugin's repo to push changes and open PRs. Choose from the following two options: | ||
|
|
||
| ### Add a personal access token | ||
| ### A personal access token |
There was a problem hiding this comment.
The heading doesn't follow sentence case as required by the documentation guidelines. Change 'A personal access token' to 'Personal access token' to follow the sentence case convention specified in the coding guidelines.
| token: ${{ secrets.GH_PAT_TOKEN }} | ||
| ``` | ||
|
|
||
| ### A github app |
There was a problem hiding this comment.
Corrected capitalization of 'github' to 'GitHub' (proper noun).
| ### A github app | |
| ### A GitHub app |
| token: ${{ secrets.GH_PAT_TOKEN }} | ||
| ``` | ||
|
|
||
| ### A github app |
There was a problem hiding this comment.
The heading doesn't follow sentence case as required by the documentation guidelines. Change 'A github app' to 'GitHub App' to follow the sentence case convention.
|
|
||
| ### A github app | ||
|
|
||
| Alternatively, [create a GitHub App](https://docs.github.com/en/apps/creating-github-apps/registering-a-github-app/registering-a-github-app) which offers better security and isn't tied to an individual user account. Once created, give it access to your plugins repository with read and write permissions for `contents`, `pull requests` and `workflows`. Next install the app in your plugins repo, then generate a private key. Next add both the `APP_ID` and the `PRIVATE_KEY` to your repos secrets and use the app token in the workflow like so: |
There was a problem hiding this comment.
The paragraph contains multiple sentences that start with 'Next' which creates repetitive flow. Consider restructuring: 'Alternatively, create a GitHub App which offers better security and isn't tied to an individual user account. Once created, give it access to your plugins repository with read and write permissions for contents, pull requests and workflows. Install the app in your plugins repo, then generate a private key. Add both the APP_ID and the PRIVATE_KEY to your repos secrets and use the app token in the workflow:'
1 participant
What this PR does / why we need it:
Adds an image to showcase what permissions are needed for cp-update workflow and adds a section explaining how to use a gh app with the workflow.
Which issue(s) this PR fixes:
Fixes #
Special notes for your reviewer: