Skip to content

Update CI documentation to reflect automated target generation#867

Merged
igorpecovnik merged 4 commits intomainfrom
update-ci-documentation
Jan 22, 2026
Merged

Update CI documentation to reflect automated target generation#867
igorpecovnik merged 4 commits intomainfrom
update-ci-documentation

Conversation

@igorpecovnik
Copy link
Copy Markdown
Member

@igorpecovnik igorpecovnik commented Jan 22, 2026

This PR updates the CI documentation to reflect the changes introduced in armbian.github.io#184, which moved target generation from template-based to automated generation from image-info.json.

Changes

Added monitoring page notice

Updated target generation section

  • References moved from armbian/os to armbian/armbian.github.io
  • Added explanation of automatic target generation from image-info.json
  • Listed all 4 generated target files with their purposes

New hardware-based classification section

  • Added detailed table explaining board categories
  • Listed complete slow hardware criteria
  • Explained desktop selection (GNOME for fast, XFCE for slow)

Automatic extensions documentation

  • Documented v4l2loopback-dkms and mesa-vpu for fast HDMI boards
  • Explained that manual extensions merge with automatic ones

Updated manual overrides section

  • Corrected paths for blacklist files (now in release-targets/)
  • Added manual targets (.manual files) documentation
  • Updated extensions map format and wildcard usage

Updated all file path references

  • Changed from userpatches/targets-*.yaml to release-targets/targets-*.yaml
  • Changed from armbian/os to armbian/armbian.github.io repository
  • Removed references to template files (no longer used)

The documentation now accurately reflects the new automated target generation system with hardware-based desktop selection and proper categorization of boards.

Related to: armbian/armbian.github.io#184

Create docs preview on PR

Documentation website preview will be available shortly:


 Open WWW preview 

- Add note about actions.armbian.com monitoring page
- Update target generation section with new armbian.github.io repo location
- Document hardware-based board classification (fast/slow/headless/riscv64/loongarch)
- Explain automatic extensions for fast HDMI boards
- Update manual overrides section with correct file paths
- Update all YAML file references to point to new repository location
- Remove outdated template file references

This aligns with PR #184 which introduced automated target generation
from image-info.json with hardware-based desktop selection.
@github-actions github-actions bot added size/medium PR with more then 50 and less then 250 lines Needs review Seeking for review labels Jan 22, 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Jan 22, 2026

Warning

Rate limit exceeded

@igorpecovnik has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 0 minutes and 18 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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.

Walkthrough

Updated CI process documentation (docs/Process_CI.md) to replace template-based target generation with image-info.json-driven target YAML generation (generate-targets.yaml); restructured hardware board classification into categories (Fast HDMI, Slow HDMI, Headless, RISC-V, LoongArch); introduced automatic extensions with an extensions map format and manual overrides (blacklisting/manual targets); replaced workflow/generated file path references with armbian.github.io release-targets paths; corrected terminology and removed legacy sections; and relaxed WeasyPrint in requirements.txt from weasyprint==68.0 to weasyprint>=60.0.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

  • armbian/documentation PR 789 — Modifies the Process_CI.md Extensions area (adds kernel-description.json) and is closely related to this PR’s extensions/map and merging changes.
🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title 'Update CI documentation to reflect automated target generation' directly and clearly summarizes the main change: updating documentation to reflect the shift from template-based to automated target generation.
Description check ✅ Passed The description is comprehensive and directly related to the changeset, detailing all major documentation updates including monitoring notices, target generation changes, hardware classification, extensions documentation, and file path updates.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch update-ci-documentation

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitai coderabbitai bot requested a review from SuperKali January 22, 2026 12:41
github-actions bot pushed a commit that referenced this pull request Jan 22, 2026
@igorpecovnik igorpecovnik force-pushed the update-ci-documentation branch from 96ab71c to 4e6e9e0 Compare January 22, 2026 13:25
github-actions bot pushed a commit that referenced this pull request Jan 22, 2026
@igorpecovnik igorpecovnik force-pushed the update-ci-documentation branch from 4e6e9e0 to 1264bb7 Compare January 22, 2026 13:27
github-actions bot pushed a commit that referenced this pull request Jan 22, 2026
Version 68.0 doesn't exist. Changed to >=60.0 to match available versions.
@igorpecovnik igorpecovnik force-pushed the update-ci-documentation branch from 1264bb7 to e7fe741 Compare January 22, 2026 13:29
github-actions bot pushed a commit that referenced this pull request Jan 22, 2026
github-actions bot pushed a commit that referenced this pull request Jan 22, 2026
github-actions bot pushed a commit that referenced this pull request Jan 22, 2026
@igorpecovnik igorpecovnik force-pushed the update-ci-documentation branch from cf45649 to 0bc9786 Compare January 22, 2026 13:47
github-actions bot pushed a commit that referenced this pull request Jan 22, 2026
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Fix all issues with AI agents
In `@docs/Process_CI.md`:
- Around line 74-105: Update the fenced code blocks to include a language
identifier (yaml) and ensure there is a blank line before and after each fence;
specifically modify the blocks containing the lines
"release-targets/targets-release-nightly.blacklist" /
"release-targets/targets-release-community-maintained.blacklist",
"release-targets/targets-release-nightly.manual" /
"release-targets/targets-release-community-maintained.manual",
"release-targets/targets-extensions.map", and the blocks under "Format:",
"Example:" and "Wildcards apply to all branches:" so each uses ```yaml and is
separated from surrounding text by a blank line on both sides to satisfy
MD031/MD040.

@igorpecovnik igorpecovnik force-pushed the update-ci-documentation branch from 0bc9786 to 6826339 Compare January 22, 2026 13:56
github-actions bot pushed a commit that referenced this pull request Jan 22, 2026
@igorpecovnik igorpecovnik force-pushed the update-ci-documentation branch from 6826339 to 2167617 Compare January 22, 2026 13:58
github-actions bot pushed a commit that referenced this pull request Jan 22, 2026
@igorpecovnik igorpecovnik force-pushed the update-ci-documentation branch from 2167617 to 63d419c Compare January 22, 2026 18:13
github-actions bot pushed a commit that referenced this pull request Jan 22, 2026
@igorpecovnik igorpecovnik force-pushed the update-ci-documentation branch from 63d419c to 2fb4d7b Compare January 22, 2026 19:10
github-actions bot pushed a commit that referenced this pull request Jan 22, 2026
@igorpecovnik igorpecovnik force-pushed the update-ci-documentation branch from 2fb4d7b to 8180745 Compare January 22, 2026 20:08
github-actions bot pushed a commit that referenced this pull request Jan 22, 2026
@igorpecovnik igorpecovnik force-pushed the update-ci-documentation branch from 8180745 to d2b4b4e Compare January 22, 2026 20:33
github-actions bot pushed a commit that referenced this pull request Jan 22, 2026
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Fix all issues with AI agents
In `@docs/Process_CI.md`:
- Line 103: Add a blank line immediately before the "### Kernel Descriptions for
Download Pages" heading so the Markdown has an empty line separating the
previous paragraph/block and the heading; locate the heading text "### Kernel
Descriptions for Download Pages" and insert one newline above it.
♻️ Duplicate comments (1)
docs/Process_CI.md (1)

87-99: Fix code block formatting (already flagged).

The code blocks are missing language identifiers (yaml) and blank lines before/after. This issue was already identified in a previous review.

@igorpecovnik igorpecovnik force-pushed the update-ci-documentation branch from d2b4b4e to 634fb41 Compare January 22, 2026 20:54
@igorpecovnik igorpecovnik added Ready to merge Reviewed, tested and ready for merge and removed Needs review Seeking for review labels Jan 22, 2026
@igorpecovnik igorpecovnik merged commit 57723b2 into main Jan 22, 2026
1 check passed
@igorpecovnik igorpecovnik deleted the update-ci-documentation branch January 22, 2026 23:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Ready to merge Reviewed, tested and ready for merge size/medium PR with more then 50 and less then 250 lines

Development

Successfully merging this pull request may close these issues.

1 participant