armbian-build/.github/workflows
ColorfulRhino 03c51a301a GH Actions: Beautify kernel hardening analysis
GitHub job summaries do not support colored output, but the kernel hardening script is using colored output. Thus, the job summary in the Actions panel is littered with ugly characters. This commit replaces them with emojis to enhance visibility.
2024-03-26 23:26:36 +01:00
..
build-artifacts-pr.yml We don't need to restart kernel recompilation upon PR text changes 2023-11-21 20:22:39 +01:00
build-board-list.yml build(deps): bump peter-evans/repository-dispatch from 2 to 3 2024-01-29 19:42:37 +01:00
build-train.yml build(deps): bump peter-evans/repository-dispatch from 2 to 3 2024-01-29 19:42:37 +01:00
forked-helper.yml GH Actions: forked-helper: Fix deprecated ::set-output, fix 404 link 2024-03-09 20:03:52 +01:00
kernel-security-analysis-pr.yml GH Actions: Beautify kernel hardening analysis 2024-03-26 23:26:36 +01:00
labeler.yml Fix automatic labeling system due to upstream breaking change (#6011) 2023-12-05 12:10:35 +01:00
labels-from-yml.yml Enable workflow_dispatch command for labels regenerate 2024-01-30 13:17:39 +01:00
lint-scripts-pr.yml build(deps): bump tj-actions/changed-files from 42 to 43 2024-03-18 19:39:18 +01:00
open-jira-ticket.yml Open a Jira ticket when GitHub issue is raised (#4887) 2023-03-02 19:09:55 +01:00
pr-size-labeler.yml Fix pr-size-labeler again as its still not working 2023-11-25 20:19:29 +01:00
README.md GH Actions: Update README.md on how to create and use ARMBIAN_SELF_DISPATCH_TOKEN 2024-03-09 20:03:52 +01:00
rebase.yml build(deps): bump actions/checkout from 3 to 4 2023-09-06 13:09:07 +02:00
scorecard.yml build(deps): bump actions/upload-artifact from 4.3.0 to 4.3.1 (#6273) 2024-02-12 20:06:16 +01:00

Runners requirements

  • big (6-16 cores, 64Gb SSD, 16Gb memory, 2Gb swap)
  • small (4 cores, 64Gb SSD, 8Gb memory, 2Gb swap)

Preparation

Adding x86 runner to your Jammy VM (check here if any changes):

$ mkdir actions-runner 
$ cd actions-runner
$ curl -o actions-runner-linux-x64-2.294.0.tar.gz -L https://github.com/actions/runner/releases/download/v2.294.0/actions-runner-linux-x64-2.294.0.tar.gz
$ tar xzf ./actions-runner-linux-x64-2.294.0.tar.gz

Configuration

Once asked, tag your runner accordingly:

  • small
  • big
  • arm64

Start the configuration experience

$ ./config.sh --url https://github.com/armbian --token XXXXXXXXXXXXXXXXXXXXXXXXXXX

You need to get a valid token from our DevOps team to proceed.

Create startup scripts

sudo ./svc.sh install # install
sudo ./svc.sh start   # start
sudo ./svc.sh status  # check

Use workflows in forked repositories

forked-helper.yml workflow helper can help to run custom workflows on the forked repositories.

  1. Create a fine-grained Personal Access Token (PAT) with the repo scope and store it as a secret. It needs the following permissions on the target repositories:
    • contents: read & write
    • metadata: read only (automatically selected when selecting the contents permission)
  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
  5. Create workflow with repository_dispatch in default branch.
  6. Run any need actions in this workflow.

Workflow example:

name: Test Armbian dispatch

on:
  repository_dispatch:
    types: ["armbian"]

jobs:
  show-dispatch:
    name: Show dispatch event details
    runs-on: ubuntu-latest
    steps:
      - uses: hmarr/debug-action@v2