|
14 | 14 |
|
15 | 15 | ```bash |
16 | 16 | git clone https://github.com/armbian/build |
17 | | -cd build |
| 17 | +cd build |
18 | 18 | ``` |
19 | 19 | !!! note |
20 | 20 | - Make sure that full path to the build script **does not contain spaces** |
@@ -140,3 +140,54 @@ For much more verbose logs set switch 'DEBUG=yes'. |
140 | 140 | ## GitHub Actions |
141 | 141 |
|
142 | 142 | If you do not have the proper equipment to build images on your own, you can use our [GitHub Action](https://github.com/marketplace/actions/rebuild-armbian). |
| 143 | + |
| 144 | +### Minimal workflow example |
| 145 | + |
| 146 | +Create `.github/workflows/build.yml` in your repository: |
| 147 | + |
| 148 | +```yaml |
| 149 | +name: Build Armbian Image |
| 150 | +on: |
| 151 | + workflow_dispatch: |
| 152 | + |
| 153 | +jobs: |
| 154 | + build: |
| 155 | + runs-on: ubuntu-latest # ubuntu-24.04-arm, ubuntu-24.04-riscv |
| 156 | + steps: |
| 157 | + - uses: armbian/build@main |
| 158 | + with: |
| 159 | + armbian_token: ${{ secrets.GITHUB_TOKEN }} |
| 160 | + armbian_board: "uefi-x86" # orangepi5 bananapif3 |
| 161 | + armbian_release: "noble" # trixie |
| 162 | + armbian_target: "build" |
| 163 | + armbian_ui: "minimal" # server xfce |
| 164 | + armbian_runner_clean: "yes" # recommended for Github runners |
| 165 | +``` |
| 166 | +
|
| 167 | +The action will build the image, create a GitHub Release in your repository and upload the artifacts. |
| 168 | +
|
| 169 | +### Inputs reference |
| 170 | +
|
| 171 | +| Input | Required | Default | Description | |
| 172 | +|---|---|---|---| |
| 173 | +| `armbian_token` | **yes** | — | GitHub access token (`GITHUB_TOKEN` or a PAT) | |
| 174 | +| `armbian_board` | no | `uefi-x86` | Hardware platform (e.g. `orangepi5`, `rock-5b`) | |
| 175 | +| `armbian_target` | no | `kernel` | Build target: `kernel` or `build` (full image) | |
| 176 | +| `armbian_branch` | no | `main` | Armbian framework branch | |
| 177 | +| `armbian_kernel_branch` | no | `current` | Kernel branch: `current`, `edge`, etc. | |
| 178 | +| `armbian_release` | no | `noble` | Userspace release (e.g. `noble`, `bookworm`, `trixie`) | |
| 179 | +| `armbian_ui` | no | `minimal` | `minimal`, `server`, or a desktop environment name (e.g. `xfce`, `gnome`) | |
| 180 | +| `armbian_version` | no | *auto* | Override version; patch level is auto-incremented from `stable.json` if not set | |
| 181 | +| `armbian_compress` | no | `sha,img,xz` | Output compression method | |
| 182 | +| `armbian_extensions` | no | — | Comma-separated list of build extensions to enable | |
| 183 | +| `armbian_pgp_key` | no | — | GPG private key for image signing (store as a secret) | |
| 184 | +| `armbian_pgp_password` | no | — | GPG passphrase (store as a secret) | |
| 185 | +| `armbian_release_title` | no | `Armbian image` | GitHub Release title | |
| 186 | +| `armbian_release_body` | no | *(link to build tools)* | GitHub Release body text | |
| 187 | +| `armbian_release_tag` | no | *auto* | GitHub Release tag; defaults to the computed version | |
| 188 | +| `armbian_artifacts` | no | `build/output/images/` | Path to artifacts for upload | |
| 189 | +| `armbian_runner_clean` | no | — | Set to any non-empty value to free disk space on GitHub-hosted runners | |
| 190 | + |
| 191 | +### Customisation |
| 192 | + |
| 193 | +If your repository contains a `userpatches/` directory, it will be merged into the build framework automatically. This allows you to add custom kernel configs, patches, or overlay files without forking the main build repository. |
0 commit comments