Enable pantsbuild language backends #5725
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
pull-request-size
bot
added
the
size/S
pull-request-size
bot
added
size/M
cognifloyd
force-pushed
the
pants-backend_packages
branch
from
d6796bd
to
5fb61e5
Compare
pull-request-size
bot
added
size/S
Eric-Arellano
approved these changes
Sep 8, 2022
amanda11
reviewed
Sep 8, 2022
pants.toml
Outdated
| backend_packages = [ | ||
| # python | ||
| "pants.backend.python", | ||
| "pants.backend.experimental.python", |
There was a problem hiding this comment.
I can't see experimental.python in list of pants backends on here: https://www.pantsbuild.org/docs/enabling-backends, why is experimental.python needed?
There was a problem hiding this comment.
OK. I left a comment. This enables support for the python publish goal (./pants publish) and the twine subsystem. The publish goal uses twine to publish wheels to pypi.
relevant docs are not linked in the sidebar because they are in the experimental backend.
https://www.pantsbuild.org/docs/python-publish-goal
https://www.pantsbuild.org/docs/reference-twine
amanda11
reviewed
Sep 8, 2022
cognifloyd
force-pushed
the
pants-backend_packages
branch
from
5fb61e5
to
106cea7
Compare
amanda11
approved these changes
Sep 9, 2022
This was referenced Sep 9, 2022
https://www.pantsbuild.org/docs/initial-configuration\#enable-backends This does not add any lint/fmt/etc backends, just the language-specific ones. The experimental.python backend is required for twine support. Twine is used to publish wheels to pypi.
cognifloyd
force-pushed
the
pants-backend_packages
branch
from
106cea7
to
21e2480
Compare
This was referenced Sep 16, 2022
This was referenced Oct 5, 2022
This was referenced Oct 13, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Background
This is part 3 of introducing
pants, as discussed in the TSC Meetings on 12 July 2022, 02 Aug 2022 and 06 Sept 2022. Pants has fine-grained per-file caching of results for lint, fmt (like black), test, etc. It also has lockfiles that work well for monorepos that have multiple python packages. With these lockfiles CI should not break when any of our dependencies or our transitive dependencies release new versions, because CI will continue to use the locked version until we explicitly relock with updates.To keep PRs as manageable/reviewable as possible, introducing pants will take a series of PRs. I do not know yet how many PRs; I will break this up into logical steps with these goals:
pantsto the st2 repo, andpantsstep-by-step.Other pants PRs include:
Overview of this PR
This PR enables language-specific backends for pants. This is step 3 in the initial configuration document:
https://www.pantsbuild.org/docs/initial-configuration#enable-backends
The next PR will do step 5 in the initial configuration document. It will be generated by running some automation to add metadata across the repo. This PR is the manual configuration that has to be done before we can run that process.
This does not add any lint/fmt/etc backends, just the language-specific ones. That will happen in PRs after we have added metadata across the repo.
pants.tomlconfig filehttps://www.pantsbuild.org/docs/initial-configuration#create-pantstoml
Many important things get configured in the
pants.tomlconfig file, but this PR only configures[GLOBAL].backend_packages.[GLOBAL].backend_packagesThe pants docs describe
[GLOBLA].backend_packagesas follows:https://www.pantsbuild.org/docs/enabling-backends
So, this is how we opt-in to different funcitonality. In this PR, we tell pants that we have python and shell files in this repo. We'll add other backends (like flake8 and black) in follow-up PRs.
Things you can do with pantsbuild
This PR does not wire up any lockfiles, formatters, linters, etc, yet.
After this PR pants has more targets (metadata about a subset of code) and goals (like
count-locorrootsfrom the previous PRs).To explore this, use the
./pants helpsystem (which is extremely helpful!).Before this PR
After this PR