Update scaffold to ship HW-Module-CI wrappers; retire sync infrastructure#2
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Updates the HW-Module-Template scaffold to the new shared CI model by removing local CI/config infrastructure and replacing it with thin GitHub Actions wrappers that call reusable workflows from OE5XRX/HW-Module-CI.
Changes:
- Replaced local GitHub Actions workflow implementations with reusable-workflow wrappers (
uses: OE5XRX/HW-Module-CI/...). - Removed retired sync + local CI assets (repo-file-sync workflow/config, KiBot YAMLs, Ruby/Jekyll/Gemfile, scripts).
- Updated documentation scaffold (
README.md,doc/index.md) and ignored CI-generateddoc/_data/project.yml.
Reviewed changes
Copilot reviewed 13 out of 16 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
.github/workflows/kibot-check.yaml |
Replaced local KiBot check job with reusable workflow wrapper. |
.github/workflows/create-debug-docs.yaml |
Replaced local debug docs pipeline with reusable workflow wrapper. |
.github/workflows/create-release-docs.yaml |
Replaced local release docs pipeline with reusable workflow wrapper. |
.github/workflows/sync.yaml |
Removed retired repo file-sync workflow. |
.github/sync.yml |
Removed retired repo-file-sync configuration. |
README.md |
Rewrote template documentation to describe shared CI model and module setup steps. |
doc/index.md |
Switched artefact paths to use {{ site.data.project.name }} for auto-detected basenames. |
.gitignore |
Ignored CI-generated doc/_data/project.yml. |
Gemfile |
Removed local Jekyll/Ruby dependencies (now owned by shared CI). |
doc/_config.yml |
Removed local Jekyll config (now owned by shared CI). |
test.kibot.yaml |
Removed local KiBot check config (now owned by shared CI). |
production.kibot.yaml |
Removed local production KiBot config (now owned by shared CI). |
scripts/requirements.txt |
Removed script dependency list (scripts retired from template). |
scripts/bom-export.py |
Removed InvenTree BOM export script (now owned by shared CI). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| verbose: 0 | ||
| check: | ||
| uses: OE5XRX/HW-Module-CI/.github/workflows/kibot-check.yaml@main | ||
| secrets: inherit |
| target-folder: ${{ env.DEPLOY_PATH }} | ||
| clean: true | ||
| build: | ||
| uses: OE5XRX/HW-Module-CI/.github/workflows/create-debug-docs.yaml@main |
| target-folder: docs/remote-station/hardware/${{ github.event.repository.name }} | ||
| clean: true | ||
| build: | ||
| uses: OE5XRX/HW-Module-CI/.github/workflows/create-release-docs.yaml@main |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Update HW-Module-Template scaffold to the new shared-CI world. Anyone clicking "Use this template" now gets a module that's pre-wired to
OE5XRX/HW-Module-CI@main.Changes:
uses: OE5XRX/HW-Module-CI/...@main.github/workflows/sync.yaml,.github/sync.yml) — the BetaHuhn/repo-file-sync-action workflow is FULLY RETIRED across the OE5XRX HW ecosystemscripts/,Gemfile,*.kibot.yaml,doc/_config.yml,doc/favicon.ico,doc/Icon.png— all CI assets live in HW-Module-CIdoc/index.md: scaffold uses Liquid{{ site.data.project.name }}for artefact paths (preserved<NAME>placeholders)README.md: rewritten — new scaffold model, points users at HW-Module-CI for internals.gitignore: exclude CI-generateddoc/_data/project.ymlThis is the LAST PR in the HW-Module-CI rollout — after merge, every HW repo (5 modules + DebugBoard + template) is on the new world and BetaHuhn/repo-file-sync-action is fully retired.
Test Plan
Template has no
.kicad_pro, so the wrapper workflows would fail if triggered (auto-detection finds zero.kicad_pro). Intentional — Template isn't a consumer.<NAME>placeholders intact)