Skip to content

Commit ea75b69

Browse files
authored
Merge branch 'master' into docs/sbom-server-tables-363
2 parents f6e4d1e + c4cfa87 commit ea75b69

1 file changed

Lines changed: 17 additions & 13 deletions

File tree

docs/_ecosystem_8x/devkit/migrating.md

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -16,18 +16,22 @@ If you get an error about a command not being available, you probably just need
1616

1717
{% include alert.html type="tip" content="There are a few exceptions to this pattern. For example, Jig is an installed package and VoxBox is a Docker container." %}
1818

19-
| You used to type... | Now you type... |
20-
|---------------------|------------------|
21-
| `pdk new module` | `jig new module` |
22-
| `pdk new class` | `jig new class` |
23-
| `pdk build` | `jig build` |
24-
| `pdk release` | `jig release` |
25-
| `pdk convert` | _not needed_ |
26-
| `pdk update` | `jig update` |
27-
| `pdk validate` | `jig validate` |
28-
| `pdk test unit` | `jig test unit` |
29-
30-
`jig update`, `jig validate`, and `jig test unit` are thin wrappers around `bundle exec msync update`, `bundle exec rake validate lint`, and `bundle exec rake spec` respectively, so they still need the module's gems installed (`bundle install`).
31-
You can keep running the underlying `bundle exec` commands directly if you prefer.
19+
Jig also contains thin wrappers around the `bundle exec` commands, so in many cases you can use the CLI patterns you're used to typing.
20+
Because Jig does not attempt to hide the Bundler environment from you, it will still need the module's gems installed (`bundle install`) and ModuleSync configured properly.
21+
22+
{% include alert.html type="tip" title="Choosing command forms" content="If you want quick and familiar commands to run locally, then use the Jig wrapper commands. If you're running tests and such in CI or if you need to pass custom options then invoke the tools directly." %}
23+
24+
| You used to type... | Now you type... | Or run tools directly... |
25+
|---------------------|------------------|----------------------------------|
26+
| `pdk new module` | `jig new module` | |
27+
| `pdk new class` | `jig new class` | |
28+
| `pdk build` | `jig build` | |
29+
| `pdk release` | `jig release` | |
30+
| `pdk convert` | _not needed_ | |
31+
| `pdk update` | `jig update`* | `bundle exec msync update`* |
32+
| `pdk validate` | `jig validate` | `bundle exec rake validate lint` |
33+
| `pdk test unit` | `jig test unit` | `bundle exec rake spec` |
34+
35+
{% include alert.html type="note" title="*NOTE" content="`pdk update` operates in context of a single module. In contrast, the replacement ModuleSync commands (`jig update` and `bundle exec msync update`) should be run in the template repository to push updates to all your modules at once. [Read more](modulesync.html)." %}
3236

3337
Browse through the individual subpages of this Developer Tooling section to learn more about each component.

0 commit comments

Comments
 (0)