Skip to content

feat: add missing jig convert information - #417

Open
tuxmea wants to merge 2 commits into
masterfrom
feat/jig_convert
Open

feat: add missing jig convert information#417
tuxmea wants to merge 2 commits into
masterfrom
feat/jig_convert

Conversation

@tuxmea

@tuxmea tuxmea commented Jul 22, 2026

Copy link
Copy Markdown
Contributor

Short description

Jig is now able to convert PDK based modules to VoxBox compatibility.
e.g. PDK used the puppetlabs_spec_helper gem, which has been removed from OpenVoxtesting.

Checklist

I have:

Signed-off-by: Martin Alfke <ma@betadots.de>
Copilot AI review requested due to automatic review settings July 22, 2026 17:44
@tuxmea
tuxmea requested a review from a team as a code owner July 22, 2026 17:44

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 DevKit migration guide to document Jig’s new ability to convert PDK-based modules for OpenVox/VoxBox compatibility, helping users transition off the PDK with less manual editing.

Changes:

  • Add documentation noting jig convert availability (from Jig v1.5.0) and what files it updates.
  • Update the PDK→Jig command mapping table to include jig convert (instead of “not needed”) and fix table formatting.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/_ecosystem_8x/devkit/migrating.md Outdated
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Martin Alfke <tuxmea@users.noreply.github.com>
Copilot AI review requested due to automatic review settings July 22, 2026 18:01

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

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

@miharp miharp left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Filed #422 for fuller jig convert docs on the Jig reference page, follow-up, not
a blocker for this PR.


| You used to type... | Now you type... | Or run tools directly... |
|---------------------|------------------|----------------------------------|
| ---------------------| ------------------| ----------------------------------|

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Was this delimiter change intentional?

It adds a space after each opening pipe but not before the closing one, so the
delimiter row no longer lines up with the header and body rows. As far as I can
tell this is the only table in docs/ shaped that way — 28 files use | --- |
and 7 use |---|.

It renders fine either way, so no real harm. Just wondering whether it's worth
reverting to keep the diff focused on the jig convert change?

Most are shipped as gems that you'll add to a module's `Gemfile`.
This means that you'll maintain your own Ruby and Bundler installs, but most other tooling will be accessed via `bundle exec` commands in individual module repositories.

For simplicity, a convert command was added to Jig starting with version 1.5.0. This allows you to automatically update your module's `Gemfile`, `Rakefile`, and `spec/spec_helper.rb` to OpenVox- and VoxBox-compatible versions.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Small wording suggestion to match the style guide: active voice and second person
per the tone guidelines, jig convert in monospace so it matches
the table row it explains, and one sentence per line like the surrounding paragraphs.

Suggested change
For simplicity, a convert command was added to Jig starting with version 1.5.0. This allows you to automatically update your module's `Gemfile`, `Rakefile`, and `spec/spec_helper.rb` to OpenVox- and VoxBox-compatible versions.
Jig 1.5.0 and later includes a `jig convert` command that migrates a PDK-based module for you.
It rewrites the module's `Gemfile`, `Rakefile`, and `spec/spec_helper.rb` to OpenVox- and VoxBox-compatible versions.

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.

3 participants