Skip to content

Update scaffold to ship HW-Module-CI wrappers; retire sync infrastructure#2

Merged
peterus merged 5 commits into
mainfrom
feat/migrate-to-hw-module-ci
May 12, 2026
Merged

Update scaffold to ship HW-Module-CI wrappers; retire sync infrastructure#2
peterus merged 5 commits into
mainfrom
feat/migrate-to-hw-module-ci

Conversation

@peterus

@peterus peterus commented May 12, 2026

Copy link
Copy Markdown
Member

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:

  • 3 workflow YAMLs replaced with thin wrappers that uses: OE5XRX/HW-Module-CI/...@main
  • Deleted file-sync infrastructure (.github/workflows/sync.yaml, .github/sync.yml) — the BetaHuhn/repo-file-sync-action workflow is FULLY RETIRED across the OE5XRX HW ecosystem
  • Deleted scripts/, Gemfile, *.kibot.yaml, doc/_config.yml, doc/favicon.ico, doc/Icon.png — all CI assets live in HW-Module-CI
  • doc/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-generated doc/_data/project.yml

This 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.

  • Manual review of doc/index.md scaffold (Liquid templating + <NAME> placeholders intact)
  • Manual review of README.md (new scaffold model documented)

Copilot AI review requested due to automatic review settings May 12, 2026 05:09
@peterus peterus merged commit f991891 into main May 12, 2026
@peterus peterus deleted the feat/migrate-to-hw-module-ci branch May 12, 2026 05:09

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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-generated doc/_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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants