Migrate to HW-Module-CI shared workflows + rename KiCad files#12
Merged
Conversation
Distinguishable KiCad window titles on the desktop. The composite action
in HW-Module-CI auto-detects the project name from the basename of
*.kicad_pro, so CI behaviour is identical before and after — only the
artefact filenames change (main-bom.html -> FMTransceiver-bom.html etc.),
which doc/index.md already routes through {{ site.data.project.name }}.
Internal references updated:
- FMTransceiver.kicad_pro: 1x "filename"
- FMTransceiver.kicad_pcb: 11x (sheetfile)
- *.kicad_sch (wildcard across all 7 schematics): (project "main" ->
(project "FMTransceiver" — KiCad 9.0.8's instance-tracking blocks
exist in every hierarchical participant, ~156 occurrences total.
There was a problem hiding this comment.
Pull request overview
Migrates this hardware-module repository to the shared OE5XRX/HW-Module-CI reusable GitHub Actions workflows and renames the KiCad project files to FMTransceiver.* for clearer project/window titles, updating internal schematic/PCB references and docs artifact links accordingly.
Changes:
- Replaced in-repo CI job definitions with reusable-workflow wrappers (
uses:+secrets: inherit). - Removed local CI/support files (KiBot configs, Ruby/Jekyll setup, Python scripts) now hosted in
HW-Module-CI. - Renamed KiCad project files from
main.kicad_*→FMTransceiver.kicad_*and updated documentation links to use the detected project basename via Liquid templating.
Reviewed changes
Copilot reviewed 27 out of 30 changed files in this pull request and generated 8 comments.
Show a summary per file
| File | Description |
|---|---|
| .github/workflows/kibot-check.yaml | Replaced local KiBot check job with shared reusable workflow wrapper. |
| .github/workflows/create-release-docs.yaml | Replaced local release docs/export/deploy pipeline with shared reusable workflow wrapper. |
| .github/workflows/create-debug-docs.yaml | Replaced local debug docs/build/deploy pipeline with shared reusable workflow wrapper. |
| .gitignore | Ignores CI-generated doc/_data/project.yml. |
| doc/index.md | Switched hardcoded main-* artifact links to {{ site.data.project.name }} templating. |
| FMTransceiver.kicad_pro | Updated project metadata filename to the new KiCad project basename. |
| FMTransceiver.kicad_pcb | Updated schematic sheetfile references to FMTransceiver.kicad_sch. |
| FMTransceiver.kicad_sch | Updated KiCad “instances” project name strings from main → FMTransceiver. |
| 5V.kicad_sch | Updated KiCad “instances” project name strings from main → FMTransceiver. |
| AF_OUT-ADC-filter.kicad_sch | Updated KiCad “instances” project name strings from main → FMTransceiver. |
| DAC-MIC_IN-filter.kicad_sch | Updated KiCad “instances” project name strings from main → FMTransceiver. |
| connector_cpu.kicad_sch | Updated KiCad “instances” project name strings from main → FMTransceiver. |
| pin_driver.kicad_sch | Updated KiCad “instances” project name strings from main → FMTransceiver. |
| pin_driver_npn.kicad_sch | Updated KiCad “instances” project name strings from main → FMTransceiver. |
| test.kibot.yaml | Deleted (migrated to shared CI). |
| production.kibot.yaml | Deleted (migrated to shared CI). |
| Gemfile | Deleted (migrated to shared docs/CI). |
| doc/_config.yml | Deleted (migrated to shared docs/CI). |
| scripts/requirements.txt | Deleted (migrated to shared CI/scripts). |
| scripts/make_stencil_image.py | Deleted (migrated to shared CI/scripts). |
| scripts/bom_export.py | Deleted (migrated to shared CI/scripts). |
| scripts/inventree_sync/init.py | Deleted (migrated to shared CI/scripts). |
| scripts/inventree_sync/categories.py | Deleted (migrated to shared CI/scripts). |
| scripts/inventree_sync/client.py | Deleted (migrated to shared CI/scripts). |
| scripts/inventree_sync/default_categories.yaml | Deleted (migrated to shared CI/scripts). |
| scripts/inventree_sync/fetchers.py | Deleted (migrated to shared CI/scripts). |
| scripts/inventree_sync/models.py | Deleted (migrated to shared CI/scripts). |
| scripts/inventree_sync/part_manager.py | Deleted (migrated to shared CI/scripts). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| schema: main.kicad_sch | ||
| verbose: 0 | ||
| check: | ||
| uses: OE5XRX/HW-Module-CI/.github/workflows/kibot-check.yaml@main |
| 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 |
| clean: true | ||
| build: | ||
| uses: OE5XRX/HW-Module-CI/.github/workflows/create-debug-docs.yaml@main | ||
| secrets: inherit |
| 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 |
| clean: true | ||
| build: | ||
| uses: OE5XRX/HW-Module-CI/.github/workflows/create-release-docs.yaml@main | ||
| secrets: inherit |
Comment on lines
+12
to
+13
| <td><img src="{{ site.data.project.name }}-3D_top.png?dummy={{ site.data['hash'] }}" alt="top" /></td> | ||
| <td><img src="{{ site.data.project.name }}-3D_bottom.png?dummy={{ site.data['hash'] }}" alt="bottom" /></td> |
Comment on lines
+26
to
+31
| - [Schaltplan]({{ site.data.project.name }}-schematic.pdf) | ||
| - [BOM]({{ site.data.project.name }}-bom.html) | ||
| - [iBOM]({{ site.data.project.name }}-ibom.html) | ||
| - [JLCPCB fabrication & stencil](JLCPCB/{{ site.data.project.name }}-_JLCPCB_compress.zip) | ||
| - [JLCPCB Bom](JLCPCB/{{ site.data.project.name }}_bom_jlc.csv) | ||
| - [JLCPCB Pick&Place](JLCPCB/{{ site.data.project.name }}_cpl_jlc.csv) |
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
Replace the in-repo CI files with thin wrappers that consume the new
OE5XRX/HW-Module-CI@mainreusable workflows. First live exercise of the shared infrastructure. Plus: rename KiCad project files for distinguishable desktop window titles.Changes:
uses:wrappers (secrets: inherit).scripts/,Gemfile,*.kibot.yaml,doc/{_config.yml,favicon.ico,Icon.png}— now live inHW-Module-CI.doc/index.md: hardcodedmain-*artefact paths replaced with{{ site.data.project.name }}Liquid templating. Output paths now follow the auto-detected.kicad_probasename..gitignore: exclude the CI-generateddoc/_data/project.yml.main.kicad_*→FMTransceiver.kicad_*with 156+ internal references updated ("filename",(sheetfile ...),(project ...)instance strings across 7 schematics).Spec:
docs/superpowers/specs/2026-05-11-hw-module-ci-design.md(in OE5XRX meta-folder, not in this repo).Test Plan
KiBot Checkworkflow runs green (auto-detectsFMTransceiver.kicad_pro, runs ERC + DRC via reusable workflow)workflow_dispatchCreate Debug Docson the PR branch — verify gh-pages output renders withFMTransceiver-*.pngetc. (no broken images, nomain-*404s)