Add GitHub Actions CI page and link DevKit from Hello OpenVox - #465
Draft
miharp wants to merge 1 commit into
Draft
Add GitHub Actions CI page and link DevKit from Hello OpenVox#465miharp wants to merge 1 commit into
miharp wants to merge 1 commit into
Conversation
Add devkit/ci.md covering the voxpupuli/gha-puppet reusable workflow: the prerequisite (voxpupuli-test wired in, via the setup page or jig new module / jig convert), what the module needs first (Gemfile, Rakefile, metadata.json with an openvox or puppet requirement), the workflow file and its inputs, how the jobs map onto rake tasks, a lighter parser-validate-only alternative, and the failure modes seen when the prerequisites are missing. Add a Next Steps bullet on the Getting Started page pointing at the Developer Tooling section, which previously had no path there. Closes OpenVoxProject#464 Signed-off-by: Michael Harp <mike@mikeharp.com> Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
|
maybe out of scope: |
fsteinel
added a commit
to fsteinel/ffnord-puppet-gateway
that referenced
this pull request
Aug 29, 2026
fsteinel
added a commit
to fsteinel/ffnord-puppet-gateway
that referenced
this pull request
Aug 29, 2026
miharp
added a commit
to miharp/ffnord-puppet-gateway
that referenced
this pull request
Aug 30, 2026
Minimal setup following the OpenVox "Module CI with GitHub Actions" guide (OpenVoxProject/openvox-docs#465): metadata.json, Gemfile, Rakefile, and a workflow calling voxpupuli/gha-puppet basic.yml. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
miharp
marked this pull request as draft
August 31, 2026 10:34
Contributor
Author
|
Converting this to a draft for now. voxpupuli/jig#92 makes |
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.
Closes #464
What this adds
New page:
devkit/ci.md("Module CI with GitHub Actions"), in the sidebar as "GitHub Actions CI" between "Consistent Style" and "Using VoxBox in CI".gha-puppet'sbasic.ymlexpects to find in the module before it can run: aGemfile(test group withvoxpupuli-test,puppet_metadata, andopenvoxreadingOPENVOX_GEM_VERSION), aRakefile, and ametadata.jsonwith arequirementsentry.jig new moduleproduces all three; for any existing module with ametadata.json,jig convertregenerates the first two.ci.ymlthat calls the reusable workflow, a table of the three jobs it produces and which rake tasks each runs, and a table of thewith:inputs (taken frombasic.ymlon thev4tag rather than the README).beaker.ymlfor acceptance tests (links to the existing guide).Could not locate Gemfile,unit → skipped,metadata2ghaerrors).Getting Started page: a third Next Steps bullet pointing to the Developer Tooling section and the new CI page. The Hello OpenVox walkthrough previously had no path to the DevKit docs at all, which is how the question in #464 came up.
Verification
bundle exec jekyll buildsucceeds; the page renders underecosystem/latest/devkit/ci.html, the sidebar entry appears, and every internal link and anchor on the new page resolves to an existing page.GemfileandRakefileexamples mirror jig's current module template andpuppet-nftables, so they match what the tooling generates today.Assisted by Claude.