docs: expand GitHub Actions section with examples and inputs reference#900
docs: expand GitHub Actions section with examples and inputs reference#900igorpecovnik merged 1 commit intomainfrom
Conversation
github-actions
bot
added
Needs review
|
Warning Rate limit exceeded
Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 22 minutes and 12 seconds. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
WalkthroughThis pull request updates the Developer Guide documentation for build preparation. It removes trailing whitespace from a shell command, expands the GitHub Actions section with a complete workflow example file ( Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes 🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/Developer-Guide_Build-Preparation.md`:
- Line 164: Update the inline comment on the armbian_runner_clean setting to use
the official product capitalization: change "Github runners" to "GitHub runners"
in the comment next to armbian_runner_clean.
- Around line 171-190: Update the Input table to reference the upstream
action.yml (https://github.com/armbian/build/blob/main/action.yml) and reconcile
all defaults/descriptions to match that authoritative source; specifically
verify and correct entries such as armbian_release (default should be "jammy"
upstream), armbian_release_body, and any other fields that differ, and add a
short note or link header above the table pointing to armian/build@main
action.yml so future changes are aligned with the source of truth.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 3581db0e-c975-447c-a269-68edab710b70
📒 Files selected for processing (1)
docs/Developer-Guide_Build-Preparation.md
| armbian_release: "noble" # trixie | ||
| armbian_target: "build" | ||
| armbian_ui: "minimal" # server xfce | ||
| armbian_runner_clean: "yes" # recommended for Github runners |
There was a problem hiding this comment.
Fix product name capitalization (“Github” → “GitHub”).
Use the official casing in the inline comment for consistency with the rest of the guide.
Suggested edit
- armbian_runner_clean: "yes" # recommended for Github runners
+ armbian_runner_clean: "yes" # recommended for GitHub runners📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| armbian_runner_clean: "yes" # recommended for Github runners | |
| armbian_runner_clean: "yes" # recommended for GitHub runners |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/Developer-Guide_Build-Preparation.md` at line 164, Update the inline
comment on the armbian_runner_clean setting to use the official product
capitalization: change "Github runners" to "GitHub runners" in the comment next
to armbian_runner_clean.
| | Input | Required | Default | Description | | ||
| |---|---|---|---| | ||
| | `armbian_token` | **yes** | — | GitHub access token (`GITHUB_TOKEN` or a PAT) | | ||
| | `armbian_board` | no | `uefi-x86` | Hardware platform (e.g. `orangepi5`, `rock-5b`) | | ||
| | `armbian_target` | no | `kernel` | Build target: `kernel` or `build` (full image) | | ||
| | `armbian_branch` | no | `main` | Armbian framework branch | | ||
| | `armbian_kernel_branch` | no | `current` | Kernel branch: `current`, `edge`, etc. | | ||
| | `armbian_release` | no | `noble` | Userspace release (e.g. `noble`, `bookworm`, `trixie`) | | ||
| | `armbian_ui` | no | `minimal` | `minimal`, `server`, or a desktop environment name (e.g. `xfce`, `gnome`) | | ||
| | `armbian_version` | no | *auto* | Override version string; patch level is auto-incremented from `stable.json` if not set | | ||
| | `armbian_compress` | no | `sha,img,xz` | Output compression method | | ||
| | `armbian_extensions` | no | — | Comma-separated list of build extensions to enable | | ||
| | `armbian_pgp_key` | no | — | GPG private key for image signing (store as a secret) | | ||
| | `armbian_pgp_password` | no | — | GPG passphrase (store as a secret) | | ||
| | `armbian_release_title` | no | `Armbian image` | GitHub Release title | | ||
| | `armbian_release_body` | no | *(link to build tools)* | GitHub Release body text | | ||
| | `armbian_release_tag` | no | *auto* | GitHub Release tag; defaults to the computed version | | ||
| | `armbian_artifacts` | no | `build/output/images/` | Path to artifacts for upload | | ||
| | `armbian_runner_clean` | no | — | Set to any non-empty value to free disk space on GitHub-hosted runners | | ||
|
|
There was a problem hiding this comment.
🧩 Analysis chain
🌐 Web query:
For the GitHub Action armbian/build@main, what are the current workflow inputs, defaults, and required flags as defined in its action metadata (action.yml)? Please provide the authoritative source link and list each input.
💡 Result:
The GitHub Action armbian/build@main is defined in the action.yml file at the authoritative source: https://github.com/armbian/build/blob/main/action.yml From the action metadata extracted from source code views (commit 54808ecff253fb71615161e3a216ad14b420022b, likely current as of recent searches): Inputs (with descriptions, required status, and defaults where specified): - armbian_token: "GitHub installation access token" - required: true, default: none - armbian_runner_clean: "Make some space on GH runners" - required: false, default: "" - armbian_artifacts: "Upload PATH" - required: false, default: "build/output/images/" - armbian_target: "Build image or kernel" - required: false, default: "kernel" - armbian_branch: "Choose framework branch" - required: false, default: "main" - armbian_kernel_branch: "Choose kernel branch" - required: false, default: "current" - armbian_release: "Choose userspace release" - required: false, default: "jammy" - armbian_version: "Set different version" - required: false, default: "" - armbian_board: "Choose board" - required: false, default: none (used in examples) - armbian_ui: "User interface" - required: false, default: none (used for minimal/server/desktop decoding) - armbian_release_tittle: "Armbian release title" - required: false, default: "Armbian image" - armbian_release_body: "Armbian images" - required: false, default: "Build with Armbian tools" - armbian_release_tag: "Armbian release tag" - required: false, default: none - armbian_pgp_key: GPG key for signing - required: false, default: none - armbian_pgp_password: GPG passphrase - required: false, default: none No inputs are explicitly marked as deprecated or changed recently. The action uses 'composite' runner and handles Armbian builds, artifact upload to releases, optional signing. Examples from Marketplace and releases confirm usage like armbian_token (required), armbian_release, armbian_target, armbian_board, etc.
Citations:
- 1: https://github.com/armbian/build/blob/main/action.yml
- 2: https://github.com/armbian/build/blob/54808ecff253fb71615161e3a216ad14b420022b/action.yml#L101
- 3: https://github.com/marketplace/actions/rebuild-armbian
- 4: https://github.com/armbian/build/releases/tag/v24.2.1
- 5: https://github.com/armbian/build/tree/main
Add reference link to upstream action.yml and reconcile documentation defaults with the authoritative source.
The table currently diverges from armbian/build@main's action.yml in several places: armbian_release defaults to jammy upstream (not noble), and descriptions like armbian_release_body differ. Link to https://github.com/armbian/build/blob/main/action.yml at the top of this table for maintainability, and update any stale defaults or descriptions to match the source-of-truth.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/Developer-Guide_Build-Preparation.md` around lines 171 - 190, Update the
Input table to reference the upstream action.yml
(https://github.com/armbian/build/blob/main/action.yml) and reconcile all
defaults/descriptions to match that authoritative source; specifically verify
and correct entries such as armbian_release (default should be "jammy"
upstream), armbian_release_body, and any other fields that differ, and add a
short note or link header above the table pointing to armian/build@main
action.yml so future changes are aligned with the source of truth.
Add workflow examples, runner selection guide, full inputs reference table, and userpatches documentation to the GitHub Actions section.
1 participant
Add workflow examples, runner selection guide, full inputs reference table, and userpatches documentation to the GitHub Actions section.
Documentation website preview will be available shortly:
Open WWW preview