Skip to content
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

Extend shell_command tutorial/how-to documentation with discussion of adhoc_tool #18319

Open
chrisjrn opened this issue Feb 21, 2023 · 0 comments

Comments

@chrisjrn
Copy link
Contributor

chrisjrn commented Feb 21, 2023

Currently, the documentation lives in the "shell" section under "run shell commands".

This should live in a section on "extending Pants" (title tbd) that discusses use cases for adhoc_tool and shell_command, and discusses when one might want to write a plugin instead.


Per #18082

PROPOSAL: adhoc_tool is documented as the preferred way to run third-party tools or user-supplied code as a build step, whenever it is possible. shell_command should be introduced only for cases where Pants does not provide any support.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant