-
Notifications
You must be signed in to change notification settings - Fork 104
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
(SDK-329) implement running arbitrary commands in PDK's environment #179
Conversation
d6919a3
to
543b04e
Compare
README.md
Outdated
@@ -270,13 +270,36 @@ Multiple `--format` options can be specified as long as they all have distinct o | |||
|
|||
Specifies options to pass through to the actual test-runner. In the default template (and most commonly across modules), this is [rspec](https://relishapp.com/rspec/rspec-core/docs/command-line). | |||
|
|||
#### `pdk bundle` command |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this is indented one hash too many
README.md
Outdated
@@ -270,13 +270,36 @@ Multiple `--format` options can be specified as long as they all have distinct o | |||
|
|||
Specifies options to pass through to the actual test-runner. In the default template (and most commonly across modules), this is [rspec](https://relishapp.com/rspec/rspec-core/docs/command-line). | |||
|
|||
#### `pdk bundle` command | |||
|
|||
This experimental command allows you to execute arbitrary commands in a bundler context within the module you're currently working on. Arguments to this command are passed straight through to bundler. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The command text says this is for 'advanced users' - we might want at least that level of warning here; if not a stronger warning that the user should know what they're doing (e.g. they might install a gem to system with this command, causing problems on their machine)?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ha, I copied it from the one heading that had it wrong. fixed both now.
543b04e
to
b6ec814
Compare
README.md
Outdated
|
||
This experimental command allows you to execute arbitrary commands in a bundler context within the module you're currently working on. Arguments to this command are passed straight through to bundler. | ||
|
||
Note that for most advanced uses it is required to use the `--` to separate bundler options from pdk options. Compare the following two commands: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The command text says this is for 'advanced users' - we might want at least that level of warning here; if not a stronger warning that the user should know what they're doing (e.g. they might install a gem to system with this command, causing problems on their machine)?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good call. I'll make the language a bit stronger.
b6ec814
to
9178936
Compare
Updated, addressing all recommendations. |
No description provided.