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

Replace the `goals` goal with a `help` plugin which supports both v1 and v2 #7598

Merged

Conversation

Projects
None yet
2 participants
@stuhood
Copy link
Member

commented Apr 20, 2019

Problem

In #6880, there will be two types of Goals:

  1. v1 pants.goal.goal.Goals, registered on a singleton
  2. v2 pants.engine.goal.Goals, registered as a ScopeInfo category via @console_rules.

But ./pants goals supports only the first form (via access to the singleton), and would need to dig deep into self.context in order to get access to the scope info (...like ./pants options does: but that's a story for another day!).

Solution

Convert ./pants goals into a plugin to the arg splitter, similar to ./pants help. While the arg-splitter method is not incredibly scalable, it seems like it should be sufficiently scalable to support most of our "meta-goals".

Result

v1 and v2 Goals are supported, we have one fewer v1 Task, and #6880 is unblocked.

@stuhood stuhood force-pushed the twitter:stuhood/replace-goals-task-with-help-printer branch from 408b9d6 to eb5d4b9 Apr 20, 2019

@stuhood stuhood requested review from illicitonion, benjyw and jsirois Apr 20, 2019

Show resolved Hide resolved tests/python/pants_test/help/test_list_goals_integration.py Outdated
from pants_test.pants_run_integration_test import PantsRunIntegrationTest


class TestListGoalsIntegration(PantsRunIntegrationTest):

This comment has been minimized.

Copy link
@jsirois

jsirois Apr 20, 2019

Member

It would be great to unit test instead.

Show resolved Hide resolved src/python/pants/help/help_printer.py Outdated

@stuhood stuhood merged commit d31c194 into pantsbuild:master Apr 20, 2019

1 check failed

continuous-integration/travis-ci/pr The Travis CI build failed
Details

@stuhood stuhood deleted the twitter:stuhood/replace-goals-task-with-help-printer branch Apr 20, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.