enoch/armbian-build
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

GH Actions: Update README.md on how to create and use ARMBIAN_SELF_DISPATCH_TOKEN

Browse Source
This commit is contained in:
ColorfulRhino 2024-03-08 18:12:41 +01:00 committed by Igor
parent d3a6e0b26f
commit 8cd1a3d15e
1 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
.github/workflows/README.md vendored
View File

@ -38,10 +38,14 @@ You need to get a valid token from our DevOps team to proceed.
`forked-helper.yml` workflow helper can help to run custom workflows on the forked repositories. `forked-helper.yml` workflow helper can help to run custom workflows on the forked repositories.
1. Set `ARMBIAN_SELF_DISPATCH_TOKEN` secret on your repository with `security_events` permissions. 1. Create a [fine-grained Personal Access Token (PAT)](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token) with the `repo` scope and store it as a secret. It needs the following permissions on the target repositories:
2. Helper will dispatch `repository_dispatch` event `armbian` on `push`, `release`, `deployment`, - `contents`: read & write
`pull_request` and `workflow_dispatch` events. All needed event details you can find in `client_payload` - `metadata`: read only (automatically selected when selecting the contents permission)
property of the event. 2. Create a secret named `ARMBIAN_SELF_DISPATCH_TOKEN` on your repository with `security_events` permissions. To do this, head to your forked repository, go to `Settings` on the top bar, select `Secrets and variables` and then `Actions`. From here you can create a new repository secret.
- `Name`: `ARMBIAN_SELF_DISPATCH_TOKEN`
- `Secret`: Paste your fine-grained Personal Access Token that you created in step 1 here
3. Helper will dispatch `repository_dispatch` event `armbian` on `push`, `release`, `deployment`,
`pull_request` and `workflow_dispatch` events. All needed event details you can find in `client_payload` property of the event.
4. Create empty default branch in forked repository 4. Create empty default branch in forked repository
5. Create workflow with `repository_dispatch` in default branch. 5. Create workflow with `repository_dispatch` in default branch.
6. Run any need actions in this workflow. 6. Run any need actions in this workflow.