From ac1d7051581bf4be77abd95b0405aa97202e6aad Mon Sep 17 00:00:00 2001 From: "Worker Pants (Pantsbuild GitHub Automation Bot)" <133242086+WorkerPants@users.noreply.github.com> Date: Mon, 4 Mar 2024 15:07:38 -0800 Subject: [PATCH] Update docs site for version 2.19.1 (#168) Docs from https://github.com/pantsbuild/pants/releases/tag/release_2.19.1 --- .../contributions/development/style-guide.mdx | 14 +- .../releases/release-process.mdx | 32 +- .../docs/python/overview/lockfiles.mdx | 3 + .../docs/shell/run-shell-commands.mdx | 2 +- .../docs/terraform/_category_.json | 2 +- .../docs/using-pants/setting-up-an-ide.mdx | 2 +- .../version-2.19/reference/goals/export.mdx | 2 + .../version-2.19/reference/help-all.json | 1486 +++++++++-------- .../subsystems/google-java-format.mdx | 2 +- .../reference/subsystems/jarjar.mdx | 2 +- .../reference/subsystems/java-avro.mdx | 2 +- .../reference/subsystems/junit.mdx | 2 +- .../reference/subsystems/ktlint.mdx | 2 +- .../subsystems/openapi-generator.mdx | 2 +- .../subsystems/protobuf-java-grpc.mdx | 2 +- .../reference/subsystems/pydocstyle.mdx | 2 +- .../reference/subsystems/scalafmt.mdx | 2 +- .../reference/subsystems/scalapb.mdx | 2 +- .../reference/subsystems/scalatest.mdx | 2 +- .../reference/subsystems/scrooge.mdx | 2 +- .../reference/targets/jvm_artifact.mdx | 2 +- .../reference/targets/pants_requirements.mdx | 2 +- .../reference/targets/python_requirement.mdx | 4 +- .../reference/targets/scala_artifact.mdx | 2 +- 24 files changed, 784 insertions(+), 793 deletions(-) diff --git a/versioned_docs/version-2.19/docs/contributions/development/style-guide.mdx b/versioned_docs/version-2.19/docs/contributions/development/style-guide.mdx index c7abb58df..86ee3c38f 100644 --- a/versioned_docs/version-2.19/docs/contributions/development/style-guide.mdx +++ b/versioned_docs/version-2.19/docs/contributions/development/style-guide.mdx @@ -418,17 +418,7 @@ It may be helpful to consider the following: - if you experience `mypy` typing issues using the `softwrap` for documenting subclasses of `Field` and `Target` classes, consider using the `help_text` convenience function - text inside the angle brackets (e.g. ``) will be ignored when rendered if not wrapped in backticks - to create a numbered or bullet list, use 2 space indentation (or use the `bullet_list` convenience function) -- to create a codeblock, use 4 space indentation (no need for triple backticks) and add one empty line between the code block and the text +- to create a codeblock, never use indentation. Only ever use triple-backtick blocks. - make sure to use backticks to highlight config sections, command-line arguments, target names, and inline code examples. -It may be difficult to confirm the accuracy of text formatting in plain Python, so you may want to generate the relevant Markdown files to be able to preview them to confirm your help strings are rendered as expected. They can be converted into Markdown files for visual inspection using a custom build script. - -You can run these commands to convert help strings to Markdown files for the `main` and your local feature branches to identify the changed files and then preview only the relevant files to confirm the rendering makes sense. - -```text -$ git checkout main -$ pants run build-support/bin/generate_docs.py -- --no-prompt --output main-docs -$ git checkout -$ pants run build-support/bin/generate_docs.py -- --no-prompt --output branch-docs -$ diff -qr main-docs branch-docs -``` +It may be difficult to confirm the accuracy of text formatting in plain Python, so you may want to run `pants help` on the relevant target/subsystem to see the resulting string. diff --git a/versioned_docs/version-2.19/docs/contributions/releases/release-process.mdx b/versioned_docs/version-2.19/docs/contributions/releases/release-process.mdx index fe52bc112..09fcd6c4b 100644 --- a/versioned_docs/version-2.19/docs/contributions/releases/release-process.mdx +++ b/versioned_docs/version-2.19/docs/contributions/releases/release-process.mdx @@ -97,33 +97,7 @@ $ git checkout -b 2.9.x $ git push upstream 2.9.x ``` -## Step 2: Update this docs site - -Note that this step can currently only be performed by a subset of maintainers due to a paid maximum number of seats. If you do not have a readme.com account, contact someone in the `#maintainers-confidential` channel in Slack to help out. - -### `dev0` - set up the new version - -Go to the [documentation dashboard](https://dash.readme.com/). In the top left dropdown, where it says the current version, click "Manage versions". Click "Add new version" and use a "v" with the minor release number, e.g. "v2.9". Fork from the prior release. Mark this new version as public by clicking on "Is public?" - -### Sync the `docs/` content - -See the `docs/NOTES.md` for instructions setting up the necessary Node tooling your first time. -You'll need to 1st login as outlined there via some variant of `npx rdme login --2fa --project pants ...`. -On the relevant release branch, run `npx rdme docs docs/markdown --version v.`; e.g: `npx rdme docs docs/markdown --version v2.8`. - -### Regenerate the reference docs - -Still on the relevant release branch, run `./pants run build-support/bin/generate_docs.py -- --sync --api-key ` with your key from [https://dash.readme.com/project/pants/v2.8/api-key](https://dash.readme.com/project/pants/v2.8/api-key). - -### `stable` releases - Update the default docsite - -The first stable release of a branch should update the "default" version of the docsite. For example: when releasing the stable `2.9.0`, the docsite would be changed to pointing from `v2.8` to pointing to `v2.9` by default. - -:::caution Don't have edit access? -Ping someone in the `#maintainers-confidential` channel in Slack to be added. Alternatively, you can "Suggest edits" in the top right corner. -::: - -## Step 3: Tag the release to trigger publishing +## Step 2: Tag the release to trigger publishing Once you have merged the `VERSION` bump — which will be on `main` for `dev` and `a0` releases, and on the release branch for release candidates — tag the release commit to trigger wheel building and publishing. @@ -141,7 +115,7 @@ Then, run: This will tag the release with your PGP key, and push the tag to origin, which will kick off a [`Release` job](https://github.com/pantsbuild/pants/actions/workflows/release.yaml) to build the wheels and publish them to PyPI. -## Step 4: Test the release +## Step 3: Test the release Run this script as a basic smoke test: @@ -151,7 +125,7 @@ Run this script as a basic smoke test: You should also check [GitHub Releases](https://github.com/pantsbuild/pants/releases) to ensure everything looks good. Find the version you released, then click it and confirm that the "Assets" list includes PEXes for macOS and Linux. -## Step 5: Run release testing on public repositories +## Step 4: Run release testing on public repositories Manually trigger a run of the [public repositories testing workflow](https://github.com/pantsbuild/pants/actions/workflows/public_repos.yaml), specifying the version just published as the "Pants version". diff --git a/versioned_docs/version-2.19/docs/python/overview/lockfiles.mdx b/versioned_docs/version-2.19/docs/python/overview/lockfiles.mdx index 9b876269a..fb3e1a86d 100644 --- a/versioned_docs/version-2.19/docs/python/overview/lockfiles.mdx +++ b/versioned_docs/version-2.19/docs/python/overview/lockfiles.mdx @@ -184,6 +184,9 @@ It is strongly recommended that these tools be installed from a hermetic lockfil The only time you need to think about this is if you want to customize the tool requirements that Pants uses. This might be the case if you want to modify the version of a tool or add extra requirements (for example, tool plugins). +:::caution Exporting tools requires a custom lockfile +::: + If you want a tool to be installed from some resolve, instead of from the built-in lockfile, you set `install_from_resolve` and `requirements` on the tool's config section: ```toml title="pants.toml" diff --git a/versioned_docs/version-2.19/docs/shell/run-shell-commands.mdx b/versioned_docs/version-2.19/docs/shell/run-shell-commands.mdx index 8ba7a9508..33f28a164 100644 --- a/versioned_docs/version-2.19/docs/shell/run-shell-commands.mdx +++ b/versioned_docs/version-2.19/docs/shell/run-shell-commands.mdx @@ -39,7 +39,7 @@ The `command` field is passed to `bash -c `. The execution sandbox will The command is limited to operating on the specific set of input files provided as dependencies, and only produces output files for other targets to consume. It is not possible to mutate any file in the workspace. -In case there are resulting files that should be captured and passed to any consuming targets, list them in the `outputs` field. To capture directories, simply add the path to the directory, with a trailing slash (as in the example `"files/"`, above). +In case there are resulting files that should be captured and passed to any consuming targets, list them in the `outputs` field. To capture directories, simply add the path to the directory, with a trailing slash (as in the example `”files/”`, above). :::note Idempotency requirement The shell command may be cancelled or retried any number of times, so it is important that any side effects are idempotent. That is, it should not matter if it is run several times, or only partially. diff --git a/versioned_docs/version-2.19/docs/terraform/_category_.json b/versioned_docs/version-2.19/docs/terraform/_category_.json index 34cb06d84..bd8fe8b26 100644 --- a/versioned_docs/version-2.19/docs/terraform/_category_.json +++ b/versioned_docs/version-2.19/docs/terraform/_category_.json @@ -1,4 +1,4 @@ { - "label": "TERRAFORM", + "label": "Terraform", "position": 11 } diff --git a/versioned_docs/version-2.19/docs/using-pants/setting-up-an-ide.mdx b/versioned_docs/version-2.19/docs/using-pants/setting-up-an-ide.mdx index 6a844c198..5f71d1875 100644 --- a/versioned_docs/version-2.19/docs/using-pants/setting-up-an-ide.mdx +++ b/versioned_docs/version-2.19/docs/using-pants/setting-up-an-ide.mdx @@ -49,7 +49,7 @@ The `--py-resolve-format=symlinked_immutable_virtualenv` option symlinks to an i ### Tool virtualenvs -`pants export` can also create a virtualenv for each of the Python tools you use via Pants, such as `black`, `isort`, `pytest`, `mypy`, `flake8` and so on (you can run `/pants help tools` to get a list of the tools Pants uses). Use the tool name as the resolve name argument to the `--resolve` flag. This allows you to configure your editor to use the same version of the tool as Pants does for workflows like formatting on save. +`pants export` can also create a virtualenv for each of the Python tools you use via Pants, such as `black`, `isort`, `pytest`, `mypy`, `flake8` and so on. This allows you to configure your editor to use the same version of the tool as Pants does for workflows like formatting on save. Follow [the instructions for creating a tool lockfile](../../python/overview/lockfiles#lockfiles-for-tools). ## Generated code diff --git a/versioned_docs/version-2.19/reference/goals/export.mdx b/versioned_docs/version-2.19/reference/goals/export.mdx index cf22dcc42..129b86e75 100644 --- a/versioned_docs/version-2.19/reference/goals/export.mdx +++ b/versioned_docs/version-2.19/reference/goals/export.mdx @@ -15,6 +15,8 @@ pants export [args] Export Pants data for use in other tools, such as IDEs. +:::caution Exporting tools requires creating a custom lockfile for them Follow [the instructions for creating tool lockfiles](../../docs/python/overview/lockfiles#lockfiles-for-tools) ::: + Backend: `pants.core` Config section: `[export]` diff --git a/versioned_docs/version-2.19/reference/help-all.json b/versioned_docs/version-2.19/reference/help-all.json index dfd27534b..272255b43 100644 --- a/versioned_docs/version-2.19/reference/help-all.json +++ b/versioned_docs/version-2.19/reference/help-all.json @@ -10560,7 +10560,7 @@ ], "env_var": "PANTS_GOOGLE_JAVA_FORMAT_LOCKFILE", "fromfile": false, - "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.19.0/src/python/pants/backend/java/lint/google_java_format/google_java_format.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=google-java-format`.", + "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.19.1/src/python/pants/backend/java/lint/google_java_format/google_java_format.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=google-java-format`.", "removal_hint": null, "removal_version": null, "scoped_cmd_line_args": [ @@ -13843,7 +13843,7 @@ ], "env_var": "PANTS_JARJAR_LOCKFILE", "fromfile": false, - "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.19.0/src/python/pants/jvm/shading/jarjar.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=jarjar`.", + "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.19.1/src/python/pants/jvm/shading/jarjar.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=jarjar`.", "removal_hint": null, "removal_version": null, "scoped_cmd_line_args": [ @@ -14163,7 +14163,7 @@ ], "env_var": "PANTS_JAVA_AVRO_LOCKFILE", "fromfile": false, - "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.19.0/src/python/pants/backend/codegen/avro/java/avro-tools.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=java-avro`.", + "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.19.1/src/python/pants/backend/codegen/avro/java/avro-tools.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=java-avro`.", "removal_hint": null, "removal_version": null, "scoped_cmd_line_args": [ @@ -14527,7 +14527,7 @@ ], "env_var": "PANTS_JUNIT_LOCKFILE", "fromfile": false, - "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.19.0/src/python/pants/jvm/test/junit.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=junit`.", + "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.19.1/src/python/pants/jvm/test/junit.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=junit`.", "removal_hint": null, "removal_version": null, "scoped_cmd_line_args": [ @@ -15329,7 +15329,7 @@ ], "env_var": "PANTS_KTLINT_LOCKFILE", "fromfile": false, - "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.19.0/src/python/pants/backend/kotlin/lint/ktlint/ktlint.lock for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=ktlint`.", + "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.19.1/src/python/pants/backend/kotlin/lint/ktlint/ktlint.lock for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=ktlint`.", "removal_hint": null, "removal_version": null, "scoped_cmd_line_args": [ @@ -18058,7 +18058,7 @@ ], "env_var": "PANTS_OPENAPI_GENERATOR_LOCKFILE", "fromfile": false, - "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.19.0/src/python/pants/backend/openapi/subsystems/openapi_generator.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=openapi-generator`.", + "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.19.1/src/python/pants/backend/openapi/subsystems/openapi_generator.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=openapi-generator`.", "removal_hint": null, "removal_version": null, "scoped_cmd_line_args": [ @@ -19870,7 +19870,7 @@ ], "env_var": "PANTS_PROTOBUF_JAVA_GRPC_LOCKFILE", "fromfile": false, - "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.19.0/src/python/pants/backend/codegen/protobuf/java/grpc-java.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=protobuf-java-grpc`.", + "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.19.1/src/python/pants/backend/codegen/protobuf/java/grpc-java.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=protobuf-java-grpc`.", "removal_hint": null, "removal_version": null, "scoped_cmd_line_args": [ @@ -20363,7 +20363,7 @@ ], "env_var": "PANTS_PYDOCSTYLE_CONFIG_DISCOVERY", "fromfile": false, - "help": "If true, Pants will include any relevant config files during runs (`setup.cfg`, `tox.ini`, `.pydocstyle`, `.pydocstyle.ini`, `.pydocstylerc`, `.pydocstylerc.ini`, and `pyproject.toml`) searching for the configuration file in this particular order.\n\nPlease note that even though `pydocstyle` keeps looking for a configuration file up the directory tree until one is found, Pants will only search for the config files in the repository root (from where you would normally run the `` command).\n\nUse `[pydocstyle].config` instead if your config is in a non-standard location.", + "help": "If true, Pants will include any relevant config files during runs (`setup.cfg`, `tox.ini`, `.pydocstyle`, `.pydocstyle.ini`, `.pydocstylerc`, `.pydocstylerc.ini`, and `pyproject.toml`) searching for the configuration file in this particular order.\n\nPlease note that even though `pydocstyle` keeps looking for a configuration file up the directory tree until one is found, Pants will only search for the config files in the repository root (from where you would normally run the `pants` command).\n\nUse `[pydocstyle].config` instead if your config is in a non-standard location.", "removal_hint": null, "removal_version": null, "scoped_cmd_line_args": [ @@ -25480,7 +25480,7 @@ "details": "", "rank": "HARDCODED", "value": { - "user-agent": "pants/2.19.0" + "user-agent": "pants/2.19.1" } } ] @@ -25779,7 +25779,7 @@ "details": "", "rank": "HARDCODED", "value": { - "user-agent": "pants/2.19.0" + "user-agent": "pants/2.19.1" } } ] @@ -26884,7 +26884,7 @@ ], "env_var": "PANTS_SCALAFMT_LOCKFILE", "fromfile": false, - "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.19.0/src/python/pants/backend/scala/lint/scalafmt/scalafmt.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=scalafmt`.", + "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.19.1/src/python/pants/backend/scala/lint/scalafmt/scalafmt.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=scalafmt`.", "removal_hint": null, "removal_version": null, "scoped_cmd_line_args": [ @@ -27124,7 +27124,7 @@ ], "env_var": "PANTS_SCALAPB_LOCKFILE", "fromfile": false, - "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.19.0/src/python/pants/backend/codegen/protobuf/scala/scalapbc.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=scalapb`.", + "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.19.1/src/python/pants/backend/codegen/protobuf/scala/scalapbc.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=scalapb`.", "removal_hint": null, "removal_version": null, "scoped_cmd_line_args": [ @@ -27324,7 +27324,7 @@ ], "env_var": "PANTS_SCALATEST_LOCKFILE", "fromfile": false, - "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.19.0/src/python/pants/backend/scala/subsystems/scalatest.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=scalatest`.", + "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.19.1/src/python/pants/backend/scala/subsystems/scalatest.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=scalatest`.", "removal_hint": null, "removal_version": null, "scoped_cmd_line_args": [ @@ -28027,7 +28027,7 @@ ], "env_var": "PANTS_SCROOGE_LOCKFILE", "fromfile": false, - "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.19.0/src/python/pants/backend/codegen/thrift/scrooge/scrooge.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=scrooge`.", + "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.19.1/src/python/pants/backend/codegen/thrift/scrooge/scrooge.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=scrooge`.", "removal_hint": null, "removal_version": null, "scoped_cmd_line_args": [ @@ -33202,12 +33202,12 @@ { "details": null, "rank": "HARDCODED", - "value": "2.19.0" + "value": "2.19.1" }, { "details": "from env var PANTS_VERSION", "rank": "ENVIRONMENT", - "value": "2.19.0" + "value": "2.19.1" } ] } @@ -34194,22 +34194,22 @@ "name_to_api_type_info": { "abc.EnvironmentAware": { "consumed_by_rules": [ - "pants.backend.python.providers.pyenv.rules.get_pyenv_install_info" + "pants.backend.codegen.thrift.apache.rules.setup_thrift_tool" ], "dependencies": [ "pants.backend.experimental.javascript", "pants.core" ], "dependents": [ - "pants.backend.python.providers.experimental.pyenv" + "pants.backend.codegen.thrift.apache.python" ], "documentation": null, "is_union": false, "module": "abc", "name": "EnvironmentAware", - "provider": "pants.backend.python.providers.experimental.pyenv", + "provider": "pants.backend.codegen.thrift.apache.python", "returned_by_rules": [ - "construct_env_aware_scope_pyenv_python_provider" + "construct_env_aware_scope_apache_thrift" ], "union_members": [], "union_type": null, @@ -57269,19 +57269,19 @@ }, "pants.core.goals.fix.Batch": { "consumed_by_rules": [ - "pants.backend.python.lint.ruff.rules.ruff_fix" + "pants.backend.codegen.protobuf.lint.buf.format_rules.run_buf_format" ], "dependencies": [ "pants.core" ], "dependents": [ - "pants.backend.experimental.python.lint.ruff" + "pants.backend.codegen.protobuf.lint.buf" ], "documentation": "Batch(tool_name: 'str', elements: 'tuple[PartitionElementT, ...]', partition_metadata: 'PartitionMetadataT', snapshot: 'Snapshot')", "is_union": true, "module": "pants.core.goals.fix", "name": "Batch", - "provider": "pants.backend.experimental.python.lint.ruff", + "provider": "pants.backend.codegen.protobuf.lint.buf", "returned_by_rules": [], "union_members": [], "union_type": "Batch", @@ -58144,19 +58144,19 @@ }, "pants.core.goals.lint.Batch": { "consumed_by_rules": [ - "pants.backend.python.lint.flake8.rules.run_flake8" + "pants.backend.docker.lint.hadolint.rules.run_hadolint" ], "dependencies": [ "pants.core" ], "dependents": [ - "pants.backend.python.lint.flake8" + "pants.backend.docker.lint.hadolint" ], "documentation": null, "is_union": true, "module": "pants.core.goals.lint", "name": "Batch", - "provider": "pants.backend.python.lint.flake8", + "provider": "pants.backend.docker.lint.hadolint", "returned_by_rules": [], "union_members": [], "union_type": "Batch", @@ -58328,19 +58328,19 @@ }, "pants.core.goals.lint.PartitionRequest": { "consumed_by_rules": [ - "pants.core.util_rules.partitions._single_partition_field_set_rules.partitioner_PydocstyleRequest" + "pants.backend.build_files.utils._get_build_file_partitioner_rules.partition_build_files_BlackRequest" ], "dependencies": [ "pants.core" ], "dependents": [ - "pants.backend.python.lint.pydocstyle" + "pants.backend.build_files.fmt.black" ], "documentation": null, "is_union": true, "module": "pants.core.goals.lint", "name": "PartitionRequest", - "provider": "pants.backend.python.lint.pydocstyle", + "provider": "pants.backend.build_files.fmt.black", "returned_by_rules": [], "union_members": [], "union_type": "PartitionRequest", @@ -59449,21 +59449,21 @@ }, "pants.core.goals.test.Batch": { "consumed_by_rules": [ - "pants.backend.scala.test.scalatest.run_scalatest_test", - "pants.backend.scala.test.scalatest.setup_scalatest_debug_request", - "pants.core.goals.test._unsupported_debug_adapter_rules.get_test_debug_adapter_request_ScalatestTestRequest" + "pants.backend.python.goals.pytest_runner.debug_python_test", + "pants.backend.python.goals.pytest_runner.debugpy_python_test", + "pants.backend.python.goals.pytest_runner.run_python_tests" ], "dependencies": [ "pants.core" ], "dependents": [ - "pants.backend.experimental.scala" + "pants.backend.python" ], "documentation": null, "is_union": true, "module": "pants.core.goals.test", "name": "Batch", - "provider": "pants.backend.experimental.scala", + "provider": "pants.backend.python", "returned_by_rules": [], "union_members": [], "union_type": "Batch", @@ -59580,19 +59580,19 @@ }, "pants.core.goals.test.PartitionRequest": { "consumed_by_rules": [ - "pants.core.util_rules.partitions._partition_per_input_field_set_rules.partitioner_ShellTestRequest" + "pants.core.util_rules.partitions._partition_per_input_field_set_rules.partitioner_JunitTestRequest" ], "dependencies": [ "pants.core" ], "dependents": [ - "pants.backend.shell" + "pants.backend.experimental.java" ], "documentation": null, "is_union": true, "module": "pants.core.goals.test", "name": "PartitionRequest", - "provider": "pants.backend.shell", + "provider": "pants.backend.experimental.java", "returned_by_rules": [], "union_members": [], "union_type": "PartitionRequest", @@ -60956,7 +60956,7 @@ "is_union": false, "module": "pants.core.util_rules.environments", "name": "OptionField", - "provider": "pants.core", + "provider": "pants.backend.python.providers.experimental.pyenv", "returned_by_rules": [], "union_members": [], "union_type": "PluginField", @@ -62277,19 +62277,19 @@ }, "pants.core.util_rules.wrap_source.GenerateWrapSourceSourcesRequest": { "consumed_by_rules": [ - "pants.core.util_rules.wrap_source.wrap_source_rule_and_target.wrap_source_ScalaSourceField" + "pants.core.util_rules.wrap_source.wrap_source_rule_and_target.wrap_source_PythonSourceField" ], "dependencies": [ "pants.engine.target" ], "dependents": [ - "pants.backend.experimental.scala" + "pants.backend.python" ], "documentation": null, "is_union": false, "module": "pants.core.util_rules.wrap_source", "name": "GenerateWrapSourceSourcesRequest", - "provider": "pants.backend.experimental.scala", + "provider": "pants.backend.python", "returned_by_rules": [], "union_members": [], "union_type": "GenerateSourcesRequest", @@ -65135,7 +65135,21 @@ "consumed_by_rules": [], "dependencies": [], "dependents": [ - "pants.backend.experimental.helm.check.kubeconform" + "pants.backend.experimental.python.lint.add_trailing_comma", + "pants.backend.experimental.python.lint.ruff", + "pants.backend.experimental.python.typecheck.pyright", + "pants.backend.experimental.python.typecheck.pytype", + "pants.backend.python.lint.autoflake", + "pants.backend.python.lint.bandit", + "pants.backend.python.lint.black", + "pants.backend.python.lint.docformatter", + "pants.backend.python.lint.flake8", + "pants.backend.python.lint.isort", + "pants.backend.python.lint.pydocstyle", + "pants.backend.python.lint.pylint", + "pants.backend.python.lint.pyupgrade", + "pants.backend.python.lint.yapf", + "pants.backend.python.typecheck.mypy" ], "documentation": null, "is_union": true, @@ -65144,13 +65158,21 @@ "provider": "pants.engine.target", "returned_by_rules": [], "union_members": [ - "KubeconformIgnoreMissingSchemasField", - "KubeconformIgnoreSourcesField", - "KubeconformKubernetesVersionField", - "KubeconformRejectKindsField", - "KubeconformSkipField", - "KubeconformSkipKindsField", - "KubeconformStrictField" + "SkipAddTrailingCommaField", + "SkipAutoflakeField", + "SkipBanditField", + "SkipBlackField", + "SkipDocformatterField", + "SkipFlake8Field", + "SkipIsortField", + "SkipMyPyField", + "SkipPyUpgradeField", + "SkipPydocstyleField", + "SkipPylintField", + "SkipPyrightField", + "SkipPytypeField", + "SkipRuffField", + "SkipYapfField" ], "union_type": null, "used_in_rules": [] @@ -69965,7 +69987,7 @@ "export", "filter" ], - "description": "Export Pants data for use in other tools, such as IDEs.", + "description": "Export Pants data for use in other tools, such as IDEs.\n\n:::caution Exporting tools requires creating a custom lockfile for them Follow [the instructions for creating tool lockfiles](../../docs/python/overview/lockfiles#lockfiles-for-tools) :::", "is_implemented": true, "name": "export", "provider": "pants.core" @@ -70894,7 +70916,7 @@ }, "construct_scope_export": { "description": null, - "documentation": "Export Pants data for use in other tools, such as IDEs.", + "documentation": "Export Pants data for use in other tools, such as IDEs.\n\n:::caution Exporting tools requires creating a custom lockfile for them Follow [the instructions for creating tool lockfiles](../../docs/python/overview/lockfiles#lockfiles-for-tools) :::", "input_gets": [ "Get(ScopedOptions, Scope, ..)" ], @@ -86019,17 +86041,17 @@ "type_hint": "str" }, { - "alias": "jvm_resolve", + "alias": "jvm_jdk", "default": null, - "description": "The resolve from `[jvm].resolves` to use when compiling this target.\n\nIf not defined, will default to `[jvm].default_resolve`.", + "description": "The major version of the JDK that this target should be built with. If not defined, will default to `[jvm].default_source_jdk`.", "provider": "pants.backend.experimental.codegen.avro.java", "required": false, "type_hint": "str | None" }, { - "alias": "jvm_jdk", + "alias": "jvm_resolve", "default": null, - "description": "The major version of the JDK that this target should be built with. If not defined, will default to `[jvm].default_source_jdk`.", + "description": "The resolve from `[jvm].resolves` to use when compiling this target.\n\nIf not defined, will default to `[jvm].default_resolve`.", "provider": "pants.backend.experimental.codegen.avro.java", "required": false, "type_hint": "str | None" @@ -86075,17 +86097,17 @@ "type_hint": "Dict[Union[str, Tuple[str, ...]], Dict[str, Any]] | None" }, { - "alias": "jvm_resolve", + "alias": "jvm_jdk", "default": null, - "description": "The resolve from `[jvm].resolves` to use when compiling this target.\n\nIf not defined, will default to `[jvm].default_resolve`.", + "description": "The major version of the JDK that this target should be built with. If not defined, will default to `[jvm].default_source_jdk`.", "provider": "pants.backend.experimental.codegen.avro.java", "required": false, "type_hint": "str | None" }, { - "alias": "jvm_jdk", + "alias": "jvm_resolve", "default": null, - "description": "The major version of the JDK that this target should be built with. If not defined, will default to `[jvm].default_source_jdk`.", + "description": "The resolve from `[jvm].resolves` to use when compiling this target.\n\nIf not defined, will default to `[jvm].default_resolve`.", "provider": "pants.backend.experimental.codegen.avro.java", "required": false, "type_hint": "str | None" @@ -86434,6 +86456,14 @@ "required": false, "type_hint": "str | None" }, + { + "alias": "subprocess_environment_env_vars", + "default": null, + "description": "Overrides the default value from the option `[subprocess-environment].env_vars` when this environment target is active.", + "provider": "pants.core", + "required": false, + "type_hint": "Iterable[str] | None" + }, { "alias": "golang_cgo_tool_search_paths", "default": null, @@ -86443,18 +86473,18 @@ "type_hint": "Iterable[str] | None" }, { - "alias": "golang_subprocess_env_vars", + "alias": "jvm_global_options", "default": null, - "description": "Overrides the default value from the option `[golang].subprocess_env_vars` when this environment target is active.", - "provider": "pants.backend.experimental.go", + "description": "Overrides the default value from the option `[jvm].global_options` when this environment target is active.", + "provider": "pants.backend.experimental.java", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "golang_cgo_c_flags", + "alias": "pex_executable_search_paths", "default": null, - "description": "Overrides the default value from the option `[golang].cgo_c_flags` when this environment target is active.", - "provider": "pants.backend.experimental.go", + "description": "Overrides the default value from the option `[pex].executable_search_paths` when this environment target is active.", + "provider": "pants.core", "required": false, "type_hint": "Iterable[str] | None" }, @@ -86467,114 +86497,114 @@ "type_hint": "str | None" }, { - "alias": "docker_env_vars", + "alias": "shell_setup_executable_search_paths", "default": null, - "description": "Overrides the default value from the option `[docker].env_vars` when this environment target is active.", - "provider": "pants.backend.docker", + "description": "Overrides the default value from the option `[shell-setup].executable_search_paths` when this environment target is active.", + "provider": "pants.backend.shell", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "python_bootstrap_search_path", + "alias": "python_native_code_ld_flags", "default": null, - "description": "Overrides the default value from the option `[python-bootstrap].search_path` when this environment target is active.", + "description": "Overrides the default value from the option `[python-native-code].ld_flags` when this environment target is active.", "provider": "pants.core", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "golang_go_search_paths", + "alias": "golang_cgo_gcc_binary_name", "default": null, - "description": "Overrides the default value from the option `[golang].go_search_paths` when this environment target is active.", + "description": "Overrides the default value from the option `[golang].cgo_gcc_binary_name` when this environment target is active.", "provider": "pants.backend.experimental.go", "required": false, - "type_hint": "Iterable[str] | None" + "type_hint": "str | None" }, { - "alias": "shell_setup_executable_search_paths", + "alias": "python_bootstrap_names", "default": null, - "description": "Overrides the default value from the option `[shell-setup].executable_search_paths` when this environment target is active.", - "provider": "pants.backend.shell", + "description": "Overrides the default value from the option `[python-bootstrap].names` when this environment target is active.", + "provider": "pants.core", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "nodejs_search_path", + "alias": "go_generate_env_vars", "default": null, - "description": "Overrides the default value from the option `[nodejs].search_path` when this environment target is active.", - "provider": "pants.backend.experimental.javascript", + "description": "Overrides the default value from the option `[go-generate].env_vars` when this environment target is active.", + "provider": "pants.backend.experimental.go", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "python_native_code_cpp_flags", + "alias": "golang_go_search_paths", "default": null, - "description": "Overrides the default value from the option `[python-native-code].cpp_flags` when this environment target is active.", - "provider": "pants.core", + "description": "Overrides the default value from the option `[golang].go_search_paths` when this environment target is active.", + "provider": "pants.backend.experimental.go", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "test_extra_env_vars", + "alias": "nodejs_corepack_env_vars", "default": null, - "description": "Overrides the default value from the option `[test].extra_env_vars` when this environment target is active.", - "provider": "pants.core", + "description": "Overrides the default value from the option `[nodejs].corepack_env_vars` when this environment target is active.", + "provider": "pants.backend.experimental.javascript", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "python_bootstrap_names", + "alias": "docker_executable_search_paths", "default": null, - "description": "Overrides the default value from the option `[python-bootstrap].names` when this environment target is active.", - "provider": "pants.core", + "description": "Overrides the default value from the option `[docker].executable_search_paths` when this environment target is active.", + "provider": "pants.backend.docker", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "golang_cgo_fortran_flags", + "alias": "golang_cgo_linker_flags", "default": null, - "description": "Overrides the default value from the option `[golang].cgo_fortran_flags` when this environment target is active.", + "description": "Overrides the default value from the option `[golang].cgo_linker_flags` when this environment target is active.", "provider": "pants.backend.experimental.go", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "golang_cgo_linker_flags", + "alias": "golang_cgo_fortran_flags", "default": null, - "description": "Overrides the default value from the option `[golang].cgo_linker_flags` when this environment target is active.", + "description": "Overrides the default value from the option `[golang].cgo_fortran_flags` when this environment target is active.", "provider": "pants.backend.experimental.go", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "system_binaries_system_binary_paths", + "alias": "apache_thrift_thrift_search_paths", "default": null, - "description": "Overrides the default value from the option `[system-binaries].system_binary_paths` when this environment target is active.", - "provider": "pants.core", + "description": "Overrides the default value from the option `[apache-thrift].thrift_search_paths` when this environment target is active.", + "provider": "pants.backend.codegen.thrift.apache.python", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "go_generate_env_vars", + "alias": "nodejs_executable_search_paths", "default": null, - "description": "Overrides the default value from the option `[go-generate].env_vars` when this environment target is active.", - "provider": "pants.backend.experimental.go", + "description": "Overrides the default value from the option `[nodejs].executable_search_paths` when this environment target is active.", + "provider": "pants.backend.experimental.javascript", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "golang_cgo_gcc_binary_name", + "alias": "golang_cgo_c_flags", "default": null, - "description": "Overrides the default value from the option `[golang].cgo_gcc_binary_name` when this environment target is active.", + "description": "Overrides the default value from the option `[golang].cgo_c_flags` when this environment target is active.", "provider": "pants.backend.experimental.go", "required": false, - "type_hint": "str | None" + "type_hint": "Iterable[str] | None" }, { - "alias": "python_native_code_ld_flags", + "alias": "pyenv_python_provider_installation_extra_env_vars", "default": null, - "description": "Overrides the default value from the option `[python-native-code].ld_flags` when this environment target is active.", - "provider": "pants.core", + "description": "Overrides the default value from the option `[pyenv-python-provider].installation_extra_env_vars` when this environment target is active.", + "provider": "pants.backend.python.providers.experimental.pyenv", "required": false, "type_hint": "Iterable[str] | None" }, @@ -86587,82 +86617,74 @@ "type_hint": "str | None" }, { - "alias": "golang_cgo_gxx_binary_name", - "default": null, - "description": "Overrides the default value from the option `[golang].cgo_gxx_binary_name` when this environment target is active.", - "provider": "pants.backend.experimental.go", - "required": false, - "type_hint": "str | None" - }, - { - "alias": "jvm_global_options", + "alias": "python_native_code_cpp_flags", "default": null, - "description": "Overrides the default value from the option `[jvm].global_options` when this environment target is active.", - "provider": "pants.backend.experimental.java", + "description": "Overrides the default value from the option `[python-native-code].cpp_flags` when this environment target is active.", + "provider": "pants.core", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "docker_executable_search_paths", + "alias": "python_bootstrap_search_path", "default": null, - "description": "Overrides the default value from the option `[docker].executable_search_paths` when this environment target is active.", - "provider": "pants.backend.docker", + "description": "Overrides the default value from the option `[python-bootstrap].search_path` when this environment target is active.", + "provider": "pants.core", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "nodejs_corepack_env_vars", + "alias": "golang_cgo_gxx_binary_name", "default": null, - "description": "Overrides the default value from the option `[nodejs].corepack_env_vars` when this environment target is active.", - "provider": "pants.backend.experimental.javascript", + "description": "Overrides the default value from the option `[golang].cgo_gxx_binary_name` when this environment target is active.", + "provider": "pants.backend.experimental.go", "required": false, - "type_hint": "Iterable[str] | None" + "type_hint": "str | None" }, { - "alias": "apache_thrift_thrift_search_paths", + "alias": "golang_subprocess_env_vars", "default": null, - "description": "Overrides the default value from the option `[apache-thrift].thrift_search_paths` when this environment target is active.", - "provider": "pants.backend.codegen.thrift.apache.python", + "description": "Overrides the default value from the option `[golang].subprocess_env_vars` when this environment target is active.", + "provider": "pants.backend.experimental.go", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "nodejs_executable_search_paths", + "alias": "system_binaries_system_binary_paths", "default": null, - "description": "Overrides the default value from the option `[nodejs].executable_search_paths` when this environment target is active.", - "provider": "pants.backend.experimental.javascript", + "description": "Overrides the default value from the option `[system-binaries].system_binary_paths` when this environment target is active.", + "provider": "pants.core", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "pex_executable_search_paths", + "alias": "docker_env_vars", "default": null, - "description": "Overrides the default value from the option `[pex].executable_search_paths` when this environment target is active.", - "provider": "pants.core", + "description": "Overrides the default value from the option `[docker].env_vars` when this environment target is active.", + "provider": "pants.backend.docker", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "subprocess_environment_env_vars", + "alias": "nodejs_search_path", "default": null, - "description": "Overrides the default value from the option `[subprocess-environment].env_vars` when this environment target is active.", - "provider": "pants.core", + "description": "Overrides the default value from the option `[nodejs].search_path` when this environment target is active.", + "provider": "pants.backend.experimental.javascript", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "pyenv_python_provider_installation_extra_env_vars", + "alias": "golang_cgo_cxx_flags", "default": null, - "description": "Overrides the default value from the option `[pyenv-python-provider].installation_extra_env_vars` when this environment target is active.", - "provider": "pants.backend.python.providers.experimental.pyenv", + "description": "Overrides the default value from the option `[golang].cgo_cxx_flags` when this environment target is active.", + "provider": "pants.backend.experimental.go", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "golang_cgo_cxx_flags", + "alias": "test_extra_env_vars", "default": null, - "description": "Overrides the default value from the option `[golang].cgo_cxx_flags` when this environment target is active.", - "provider": "pants.backend.experimental.go", + "description": "Overrides the default value from the option `[test].extra_env_vars` when this environment target is active.", + "provider": "pants.core", "required": false, "type_hint": "Iterable[str] | None" } @@ -87602,14 +87624,6 @@ "required": false, "type_hint": "bool" }, - { - "alias": "skip_go_vet", - "default": "False", - "description": "If true, don't run `go vet` on this target's code.", - "provider": "pants.backend.experimental.go.lint.vet", - "required": false, - "type_hint": "bool" - }, { "alias": "skip_golangci_lint", "default": "False", @@ -87625,6 +87639,14 @@ "provider": "pants.backend.experimental.go", "required": false, "type_hint": "bool" + }, + { + "alias": "skip_go_vet", + "default": "False", + "description": "If true, don't run `go vet` on this target's code.", + "provider": "pants.backend.experimental.go.lint.vet", + "required": false, + "type_hint": "bool" } ], "provider": "pants.backend.experimental.go", @@ -87827,20 +87849,12 @@ "type_hint": "bool" }, { - "alias": "kubeconform_kubernetes_version", - "default": null, - "description": "Kubernetes version to use for the validation.", - "provider": "pants.backend.experimental.helm.check.kubeconform", - "required": false, - "type_hint": "str | None" - }, - { - "alias": "kubeconform_ignore_missing_schemas", + "alias": "kubeconform_skip_kinds", "default": null, - "description": "Whether to fail if there are missing schemas for custom resources.", + "description": "List of kinds or GVKs to ignore.", "provider": "pants.backend.experimental.helm.check.kubeconform", "required": false, - "type_hint": "bool | None" + "type_hint": "Iterable[str] | None" }, { "alias": "kubeconform_reject_kinds", @@ -87851,21 +87865,29 @@ "type_hint": "Iterable[str] | None" }, { - "alias": "kubeconform_skip_kinds", + "alias": "kubeconform_strict", "default": null, - "description": "List of kinds or GVKs to ignore.", + "description": "Run Kubeconform in strict mode.", "provider": "pants.backend.experimental.helm.check.kubeconform", "required": false, - "type_hint": "Iterable[str] | None" + "type_hint": "bool | None" }, { - "alias": "kubeconform_strict", + "alias": "kubeconform_ignore_missing_schemas", "default": null, - "description": "Run Kubeconform in strict mode.", + "description": "Whether to fail if there are missing schemas for custom resources.", "provider": "pants.backend.experimental.helm.check.kubeconform", "required": false, "type_hint": "bool | None" }, + { + "alias": "skip_kubeconform", + "default": "False", + "description": "If set to true, do not run any kubeconform checking in this Helm target when running `pants check`.", + "provider": "pants.backend.experimental.helm.check.kubeconform", + "required": false, + "type_hint": "bool" + }, { "alias": "kubeconform_ignore_sources", "default": null, @@ -87875,12 +87897,12 @@ "type_hint": "Iterable[str] | None" }, { - "alias": "skip_kubeconform", - "default": "False", - "description": "If set to true, do not run any kubeconform checking in this Helm target when running `pants check`.", + "alias": "kubeconform_kubernetes_version", + "default": null, + "description": "Kubernetes version to use for the validation.", "provider": "pants.backend.experimental.helm.check.kubeconform", "required": false, - "type_hint": "bool" + "type_hint": "str | None" } ], "provider": "pants.backend.experimental.helm", @@ -87995,20 +88017,12 @@ "type_hint": "bool" }, { - "alias": "kubeconform_kubernetes_version", - "default": null, - "description": "Kubernetes version to use for the validation.", - "provider": "pants.backend.experimental.helm.check.kubeconform", - "required": false, - "type_hint": "str | None" - }, - { - "alias": "kubeconform_ignore_missing_schemas", + "alias": "kubeconform_skip_kinds", "default": null, - "description": "Whether to fail if there are missing schemas for custom resources.", + "description": "List of kinds or GVKs to ignore.", "provider": "pants.backend.experimental.helm.check.kubeconform", "required": false, - "type_hint": "bool | None" + "type_hint": "Iterable[str] | None" }, { "alias": "kubeconform_reject_kinds", @@ -88019,21 +88033,29 @@ "type_hint": "Iterable[str] | None" }, { - "alias": "kubeconform_skip_kinds", + "alias": "kubeconform_strict", "default": null, - "description": "List of kinds or GVKs to ignore.", + "description": "Run Kubeconform in strict mode.", "provider": "pants.backend.experimental.helm.check.kubeconform", "required": false, - "type_hint": "Iterable[str] | None" + "type_hint": "bool | None" }, { - "alias": "kubeconform_strict", + "alias": "kubeconform_ignore_missing_schemas", "default": null, - "description": "Run Kubeconform in strict mode.", + "description": "Whether to fail if there are missing schemas for custom resources.", "provider": "pants.backend.experimental.helm.check.kubeconform", "required": false, "type_hint": "bool | None" }, + { + "alias": "skip_kubeconform", + "default": "False", + "description": "If set to true, do not run any kubeconform checking in this Helm target when running `pants check`.", + "provider": "pants.backend.experimental.helm.check.kubeconform", + "required": false, + "type_hint": "bool" + }, { "alias": "kubeconform_ignore_sources", "default": null, @@ -88043,12 +88065,12 @@ "type_hint": "Iterable[str] | None" }, { - "alias": "skip_kubeconform", - "default": "False", - "description": "If set to true, do not run any kubeconform checking in this Helm target when running `pants check`.", + "alias": "kubeconform_kubernetes_version", + "default": null, + "description": "Kubernetes version to use for the validation.", "provider": "pants.backend.experimental.helm.check.kubeconform", "required": false, - "type_hint": "bool" + "type_hint": "str | None" } ], "provider": "pants.backend.experimental.helm", @@ -88781,7 +88803,7 @@ { "alias": "packages", "default": null, - "description": "The JVM packages this artifact provides for the purposes of dependency inference.\n\nFor example, the JVM artifact `junit:junit` might provide `[\"org.junit.**\"]`.\n\nUsually you can leave this field off. If unspecified, Pants will fall back to the `[java-infer].third_party_import_mapping`, then to a built in mapping (https://github.com/pantsbuild/pants/blob/release_2.19.0/src/python/pants/jvm/dependency_inference/jvm_artifact_mappings.py), and then finally it will default to the normalized `group` of the artifact. For example, in the absence of any other mapping the artifact `io.confluent:common-config` would default to providing `[\"io.confluent.**\"]`.\n\nThe package path may be made recursive to match symbols in subpackages by adding `.**` to the end of the package path. For example, specify `[\"org.junit.**\"]` to infer a dependency on the artifact for any file importing a symbol from `org.junit` or its subpackages.", + "description": "The JVM packages this artifact provides for the purposes of dependency inference.\n\nFor example, the JVM artifact `junit:junit` might provide `[\"org.junit.**\"]`.\n\nUsually you can leave this field off. If unspecified, Pants will fall back to the `[java-infer].third_party_import_mapping`, then to a built in mapping (https://github.com/pantsbuild/pants/blob/release_2.19.1/src/python/pants/jvm/dependency_inference/jvm_artifact_mappings.py), and then finally it will default to the normalized `group` of the artifact. For example, in the absence of any other mapping the artifact `io.confluent:common-config` would default to providing `[\"io.confluent.**\"]`.\n\nThe package path may be made recursive to match symbols in subpackages by adding `.**` to the end of the package path. For example, specify `[\"org.junit.**\"]` to infer a dependency on the artifact for any file importing a symbol from `org.junit` or its subpackages.", "provider": "", "required": false, "type_hint": "Iterable[str] | None" @@ -89346,6 +89368,14 @@ "required": false, "type_hint": "str | None" }, + { + "alias": "subprocess_environment_env_vars", + "default": null, + "description": "Overrides the default value from the option `[subprocess-environment].env_vars` when this environment target is active.", + "provider": "pants.core", + "required": false, + "type_hint": "Iterable[str] | None" + }, { "alias": "golang_cgo_tool_search_paths", "default": null, @@ -89355,18 +89385,18 @@ "type_hint": "Iterable[str] | None" }, { - "alias": "golang_subprocess_env_vars", + "alias": "jvm_global_options", "default": null, - "description": "Overrides the default value from the option `[golang].subprocess_env_vars` when this environment target is active.", - "provider": "pants.backend.experimental.go", + "description": "Overrides the default value from the option `[jvm].global_options` when this environment target is active.", + "provider": "pants.backend.experimental.java", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "golang_cgo_c_flags", + "alias": "pex_executable_search_paths", "default": null, - "description": "Overrides the default value from the option `[golang].cgo_c_flags` when this environment target is active.", - "provider": "pants.backend.experimental.go", + "description": "Overrides the default value from the option `[pex].executable_search_paths` when this environment target is active.", + "provider": "pants.core", "required": false, "type_hint": "Iterable[str] | None" }, @@ -89379,114 +89409,114 @@ "type_hint": "str | None" }, { - "alias": "docker_env_vars", + "alias": "shell_setup_executable_search_paths", "default": null, - "description": "Overrides the default value from the option `[docker].env_vars` when this environment target is active.", - "provider": "pants.backend.docker", + "description": "Overrides the default value from the option `[shell-setup].executable_search_paths` when this environment target is active.", + "provider": "pants.backend.shell", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "python_bootstrap_search_path", + "alias": "python_native_code_ld_flags", "default": null, - "description": "Overrides the default value from the option `[python-bootstrap].search_path` when this environment target is active.", + "description": "Overrides the default value from the option `[python-native-code].ld_flags` when this environment target is active.", "provider": "pants.core", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "golang_go_search_paths", + "alias": "golang_cgo_gcc_binary_name", "default": null, - "description": "Overrides the default value from the option `[golang].go_search_paths` when this environment target is active.", + "description": "Overrides the default value from the option `[golang].cgo_gcc_binary_name` when this environment target is active.", "provider": "pants.backend.experimental.go", "required": false, - "type_hint": "Iterable[str] | None" + "type_hint": "str | None" }, { - "alias": "shell_setup_executable_search_paths", + "alias": "python_bootstrap_names", "default": null, - "description": "Overrides the default value from the option `[shell-setup].executable_search_paths` when this environment target is active.", - "provider": "pants.backend.shell", + "description": "Overrides the default value from the option `[python-bootstrap].names` when this environment target is active.", + "provider": "pants.core", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "nodejs_search_path", + "alias": "go_generate_env_vars", "default": null, - "description": "Overrides the default value from the option `[nodejs].search_path` when this environment target is active.", - "provider": "pants.backend.experimental.javascript", + "description": "Overrides the default value from the option `[go-generate].env_vars` when this environment target is active.", + "provider": "pants.backend.experimental.go", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "python_native_code_cpp_flags", + "alias": "golang_go_search_paths", "default": null, - "description": "Overrides the default value from the option `[python-native-code].cpp_flags` when this environment target is active.", - "provider": "pants.core", + "description": "Overrides the default value from the option `[golang].go_search_paths` when this environment target is active.", + "provider": "pants.backend.experimental.go", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "test_extra_env_vars", + "alias": "nodejs_corepack_env_vars", "default": null, - "description": "Overrides the default value from the option `[test].extra_env_vars` when this environment target is active.", - "provider": "pants.core", + "description": "Overrides the default value from the option `[nodejs].corepack_env_vars` when this environment target is active.", + "provider": "pants.backend.experimental.javascript", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "python_bootstrap_names", + "alias": "docker_executable_search_paths", "default": null, - "description": "Overrides the default value from the option `[python-bootstrap].names` when this environment target is active.", - "provider": "pants.core", + "description": "Overrides the default value from the option `[docker].executable_search_paths` when this environment target is active.", + "provider": "pants.backend.docker", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "golang_cgo_fortran_flags", + "alias": "golang_cgo_linker_flags", "default": null, - "description": "Overrides the default value from the option `[golang].cgo_fortran_flags` when this environment target is active.", + "description": "Overrides the default value from the option `[golang].cgo_linker_flags` when this environment target is active.", "provider": "pants.backend.experimental.go", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "golang_cgo_linker_flags", + "alias": "golang_cgo_fortran_flags", "default": null, - "description": "Overrides the default value from the option `[golang].cgo_linker_flags` when this environment target is active.", + "description": "Overrides the default value from the option `[golang].cgo_fortran_flags` when this environment target is active.", "provider": "pants.backend.experimental.go", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "system_binaries_system_binary_paths", + "alias": "apache_thrift_thrift_search_paths", "default": null, - "description": "Overrides the default value from the option `[system-binaries].system_binary_paths` when this environment target is active.", - "provider": "pants.core", + "description": "Overrides the default value from the option `[apache-thrift].thrift_search_paths` when this environment target is active.", + "provider": "pants.backend.codegen.thrift.apache.python", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "go_generate_env_vars", + "alias": "nodejs_executable_search_paths", "default": null, - "description": "Overrides the default value from the option `[go-generate].env_vars` when this environment target is active.", - "provider": "pants.backend.experimental.go", + "description": "Overrides the default value from the option `[nodejs].executable_search_paths` when this environment target is active.", + "provider": "pants.backend.experimental.javascript", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "golang_cgo_gcc_binary_name", + "alias": "golang_cgo_c_flags", "default": null, - "description": "Overrides the default value from the option `[golang].cgo_gcc_binary_name` when this environment target is active.", + "description": "Overrides the default value from the option `[golang].cgo_c_flags` when this environment target is active.", "provider": "pants.backend.experimental.go", "required": false, - "type_hint": "str | None" + "type_hint": "Iterable[str] | None" }, { - "alias": "python_native_code_ld_flags", + "alias": "pyenv_python_provider_installation_extra_env_vars", "default": null, - "description": "Overrides the default value from the option `[python-native-code].ld_flags` when this environment target is active.", - "provider": "pants.core", + "description": "Overrides the default value from the option `[pyenv-python-provider].installation_extra_env_vars` when this environment target is active.", + "provider": "pants.backend.python.providers.experimental.pyenv", "required": false, "type_hint": "Iterable[str] | None" }, @@ -89499,82 +89529,74 @@ "type_hint": "str | None" }, { - "alias": "golang_cgo_gxx_binary_name", - "default": null, - "description": "Overrides the default value from the option `[golang].cgo_gxx_binary_name` when this environment target is active.", - "provider": "pants.backend.experimental.go", - "required": false, - "type_hint": "str | None" - }, - { - "alias": "jvm_global_options", + "alias": "python_native_code_cpp_flags", "default": null, - "description": "Overrides the default value from the option `[jvm].global_options` when this environment target is active.", - "provider": "pants.backend.experimental.java", + "description": "Overrides the default value from the option `[python-native-code].cpp_flags` when this environment target is active.", + "provider": "pants.core", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "docker_executable_search_paths", + "alias": "python_bootstrap_search_path", "default": null, - "description": "Overrides the default value from the option `[docker].executable_search_paths` when this environment target is active.", - "provider": "pants.backend.docker", + "description": "Overrides the default value from the option `[python-bootstrap].search_path` when this environment target is active.", + "provider": "pants.core", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "nodejs_corepack_env_vars", + "alias": "golang_cgo_gxx_binary_name", "default": null, - "description": "Overrides the default value from the option `[nodejs].corepack_env_vars` when this environment target is active.", - "provider": "pants.backend.experimental.javascript", + "description": "Overrides the default value from the option `[golang].cgo_gxx_binary_name` when this environment target is active.", + "provider": "pants.backend.experimental.go", "required": false, - "type_hint": "Iterable[str] | None" + "type_hint": "str | None" }, { - "alias": "apache_thrift_thrift_search_paths", + "alias": "golang_subprocess_env_vars", "default": null, - "description": "Overrides the default value from the option `[apache-thrift].thrift_search_paths` when this environment target is active.", - "provider": "pants.backend.codegen.thrift.apache.python", + "description": "Overrides the default value from the option `[golang].subprocess_env_vars` when this environment target is active.", + "provider": "pants.backend.experimental.go", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "nodejs_executable_search_paths", + "alias": "system_binaries_system_binary_paths", "default": null, - "description": "Overrides the default value from the option `[nodejs].executable_search_paths` when this environment target is active.", - "provider": "pants.backend.experimental.javascript", + "description": "Overrides the default value from the option `[system-binaries].system_binary_paths` when this environment target is active.", + "provider": "pants.core", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "pex_executable_search_paths", + "alias": "docker_env_vars", "default": null, - "description": "Overrides the default value from the option `[pex].executable_search_paths` when this environment target is active.", - "provider": "pants.core", + "description": "Overrides the default value from the option `[docker].env_vars` when this environment target is active.", + "provider": "pants.backend.docker", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "subprocess_environment_env_vars", + "alias": "nodejs_search_path", "default": null, - "description": "Overrides the default value from the option `[subprocess-environment].env_vars` when this environment target is active.", - "provider": "pants.core", + "description": "Overrides the default value from the option `[nodejs].search_path` when this environment target is active.", + "provider": "pants.backend.experimental.javascript", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "pyenv_python_provider_installation_extra_env_vars", + "alias": "golang_cgo_cxx_flags", "default": null, - "description": "Overrides the default value from the option `[pyenv-python-provider].installation_extra_env_vars` when this environment target is active.", - "provider": "pants.backend.python.providers.experimental.pyenv", + "description": "Overrides the default value from the option `[golang].cgo_cxx_flags` when this environment target is active.", + "provider": "pants.backend.experimental.go", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "golang_cgo_cxx_flags", + "alias": "test_extra_env_vars", "default": null, - "description": "Overrides the default value from the option `[golang].cgo_cxx_flags` when this environment target is active.", - "provider": "pants.backend.experimental.go", + "description": "Overrides the default value from the option `[test].extra_env_vars` when this environment target is active.", + "provider": "pants.core", "required": false, "type_hint": "Iterable[str] | None" } @@ -89723,25 +89745,9 @@ "type_hint": "str" }, { - "alias": "java_api_package", - "default": null, - "description": "Root package for generated API code", - "provider": "pants.backend.experimental.openapi.codegen.java", - "required": false, - "type_hint": "str | None" - }, - { - "alias": "java_model_package", - "default": null, - "description": "Root package for generated model code", - "provider": "pants.backend.experimental.openapi.codegen.java", - "required": false, - "type_hint": "str | None" - }, - { - "alias": "jvm_resolve", + "alias": "jvm_jdk", "default": null, - "description": "The resolve from `[jvm].resolves` to use when compiling this target.\n\nIf not defined, will default to `[jvm].default_resolve`.", + "description": "The major version of the JDK that this target should be built with. If not defined, will default to `[jvm].default_source_jdk`.", "provider": "pants.backend.experimental.openapi.codegen.java", "required": false, "type_hint": "str | None" @@ -89754,14 +89760,6 @@ "required": false, "type_hint": "bool" }, - { - "alias": "jvm_jdk", - "default": null, - "description": "The major version of the JDK that this target should be built with. If not defined, will default to `[jvm].default_source_jdk`.", - "provider": "pants.backend.experimental.openapi.codegen.java", - "required": false, - "type_hint": "str | None" - }, { "alias": "skip_java", "default": "False", @@ -89769,38 +89767,6 @@ "provider": "pants.backend.experimental.openapi.codegen.java", "required": false, "type_hint": "bool" - } - ], - "provider": "pants.backend.experimental.openapi", - "summary": "A single OpenAPI document file." - }, - "openapi_documents": { - "alias": "openapi_documents", - "description": "Generate an `openapi_document` target for each file in the `sources` field.", - "fields": [ - { - "alias": "tags", - "default": null, - "description": "Arbitrary strings to describe a target.\n\nFor example, you may tag some test targets with 'integration_test' so that you could run `pants --tag='integration_test' test ::` to only run on targets with that tag.", - "provider": "", - "required": false, - "type_hint": "Iterable[str] | None" - }, - { - "alias": "description", - "default": null, - "description": "A human-readable description of the target.\n\nUse `pants list --documented ::` to see all targets with descriptions.", - "provider": "", - "required": false, - "type_hint": "str | None" - }, - { - "alias": "sources", - "default": "('openapi.json', 'openapi.yaml', 'openapi.yml')", - "description": "A list of files and globs that belong to this target.\n\nPaths are relative to the BUILD file's directory. You can ignore files/globs by prefixing them with `!`.\n\nExample: `sources=['openapi.json']`", - "provider": "", - "required": false, - "type_hint": "Iterable[str] | None" }, { "alias": "java_api_package", @@ -89825,14 +89791,38 @@ "provider": "pants.backend.experimental.openapi.codegen.java", "required": false, "type_hint": "str | None" + } + ], + "provider": "pants.backend.experimental.openapi", + "summary": "A single OpenAPI document file." + }, + "openapi_documents": { + "alias": "openapi_documents", + "description": "Generate an `openapi_document` target for each file in the `sources` field.", + "fields": [ + { + "alias": "tags", + "default": null, + "description": "Arbitrary strings to describe a target.\n\nFor example, you may tag some test targets with 'integration_test' so that you could run `pants --tag='integration_test' test ::` to only run on targets with that tag.", + "provider": "", + "required": false, + "type_hint": "Iterable[str] | None" }, { - "alias": "skip_spectral", - "default": "False", - "description": "If true, don't run `spectral lint` on this target's code.", - "provider": "pants.backend.experimental.openapi.lint.spectral", + "alias": "description", + "default": null, + "description": "A human-readable description of the target.\n\nUse `pants list --documented ::` to see all targets with descriptions.", + "provider": "", "required": false, - "type_hint": "bool" + "type_hint": "str | None" + }, + { + "alias": "sources", + "default": "('openapi.json', 'openapi.yaml', 'openapi.yml')", + "description": "A list of files and globs that belong to this target.\n\nPaths are relative to the BUILD file's directory. You can ignore files/globs by prefixing them with `!`.\n\nExample: `sources=['openapi.json']`", + "provider": "", + "required": false, + "type_hint": "Iterable[str] | None" }, { "alias": "jvm_jdk", @@ -89842,6 +89832,14 @@ "required": false, "type_hint": "str | None" }, + { + "alias": "skip_spectral", + "default": "False", + "description": "If true, don't run `spectral lint` on this target's code.", + "provider": "pants.backend.experimental.openapi.lint.spectral", + "required": false, + "type_hint": "bool" + }, { "alias": "skip_java", "default": "False", @@ -89850,6 +89848,30 @@ "required": false, "type_hint": "bool" }, + { + "alias": "java_api_package", + "default": null, + "description": "Root package for generated API code", + "provider": "pants.backend.experimental.openapi.codegen.java", + "required": false, + "type_hint": "str | None" + }, + { + "alias": "java_model_package", + "default": null, + "description": "Root package for generated model code", + "provider": "pants.backend.experimental.openapi.codegen.java", + "required": false, + "type_hint": "str | None" + }, + { + "alias": "jvm_resolve", + "default": null, + "description": "The resolve from `[jvm].resolves` to use when compiling this target.\n\nIf not defined, will default to `[jvm].default_resolve`.", + "provider": "pants.backend.experimental.openapi.codegen.java", + "required": false, + "type_hint": "str | None" + }, { "alias": "dependencies", "default": null, @@ -90028,7 +90050,7 @@ }, { "alias": "version_spec", - "default": "'== 2.19.0'", + "default": "'== 2.19.1'", "description": "The PEP 440 version specifier version of Pants to target. E.g. `== 2.15.*`, or `>= 2.16.0, < 2.17.0`", "provider": "", "required": false, @@ -90635,12 +90657,12 @@ "type_hint": "bool" }, { - "alias": "skip_buf_format", - "default": "False", - "description": "If true, don't run `buf format` on this target's code.", - "provider": "pants.backend.codegen.protobuf.lint.buf", + "alias": "jvm_jdk", + "default": null, + "description": "The major version of the JDK that this target should be built with. If not defined, will default to `[jvm].default_source_jdk`.", + "provider": "pants.backend.experimental.codegen.protobuf.java", "required": false, - "type_hint": "bool" + "type_hint": "str | None" }, { "alias": "python_source_root", @@ -90651,12 +90673,12 @@ "type_hint": "str | None" }, { - "alias": "python_interpreter_constraints", - "default": null, - "description": "The Python interpreters this code is compatible with.\n\nEach element should be written in pip-style format, e.g. `CPython==2.7.*` or `CPython>=3.6,<4`. You can leave off `CPython` as a shorthand, e.g. `>=2.7` will be expanded to `CPython>=2.7`.\n\nSpecify more than one element to OR the constraints, e.g. `['PyPy==3.7.*', 'CPython==3.7.*']` means either PyPy 3.7 _or_ CPython 3.7.\n\nIf the field is not set, it will default to the option `[python].interpreter_constraints`.\n\nSee https://www.pantsbuild.org/v2.19/docs/python-interpreter-compatibility for how these interpreter constraints are merged with the constraints of dependencies.", - "provider": "pants.backend.codegen.protobuf.python", + "alias": "skip_buf_lint", + "default": "False", + "description": "If true, don't run `buf lint` on this target's code.", + "provider": "pants.backend.codegen.protobuf.lint.buf", "required": false, - "type_hint": "Iterable[str] | None" + "type_hint": "bool" }, { "alias": "python_resolve", @@ -90667,12 +90689,20 @@ "type_hint": "str | None" }, { - "alias": "jvm_resolve", + "alias": "python_interpreter_constraints", "default": null, - "description": "The resolve from `[jvm].resolves` to use when compiling this target.\n\nIf not defined, will default to `[jvm].default_resolve`.", - "provider": "pants.backend.experimental.codegen.protobuf.java", + "description": "The Python interpreters this code is compatible with.\n\nEach element should be written in pip-style format, e.g. `CPython==2.7.*` or `CPython>=3.6,<4`. You can leave off `CPython` as a shorthand, e.g. `>=2.7` will be expanded to `CPython>=2.7`.\n\nSpecify more than one element to OR the constraints, e.g. `['PyPy==3.7.*', 'CPython==3.7.*']` means either PyPy 3.7 _or_ CPython 3.7.\n\nIf the field is not set, it will default to the option `[python].interpreter_constraints`.\n\nSee https://www.pantsbuild.org/v2.19/docs/python-interpreter-compatibility for how these interpreter constraints are merged with the constraints of dependencies.", + "provider": "pants.backend.codegen.protobuf.python", "required": false, - "type_hint": "str | None" + "type_hint": "Iterable[str] | None" + }, + { + "alias": "skip_buf_format", + "default": "False", + "description": "If true, don't run `buf format` on this target's code.", + "provider": "pants.backend.codegen.protobuf.lint.buf", + "required": false, + "type_hint": "bool" }, { "alias": "go_mod_address", @@ -90683,20 +90713,12 @@ "type_hint": "str | None" }, { - "alias": "jvm_jdk", + "alias": "jvm_resolve", "default": null, - "description": "The major version of the JDK that this target should be built with. If not defined, will default to `[jvm].default_source_jdk`.", + "description": "The resolve from `[jvm].resolves` to use when compiling this target.\n\nIf not defined, will default to `[jvm].default_resolve`.", "provider": "pants.backend.experimental.codegen.protobuf.java", "required": false, "type_hint": "str | None" - }, - { - "alias": "skip_buf_lint", - "default": "False", - "description": "If true, don't run `buf lint` on this target's code.", - "provider": "pants.backend.codegen.protobuf.lint.buf", - "required": false, - "type_hint": "bool" } ], "provider": "pants.backend.codegen.protobuf.python", @@ -90739,20 +90761,28 @@ "type_hint": "Dict[Union[str, Tuple[str, ...]], Dict[str, Any]] | None" }, { - "alias": "skip_buf_format", + "alias": "jvm_jdk", + "default": null, + "description": "The major version of the JDK that this target should be built with. If not defined, will default to `[jvm].default_source_jdk`.", + "provider": "pants.backend.experimental.codegen.protobuf.java", + "required": false, + "type_hint": "str | None" + }, + { + "alias": "skip_buf_lint", "default": "False", - "description": "If true, don't run `buf format` on this target's code.", + "description": "If true, don't run `buf lint` on this target's code.", "provider": "pants.backend.codegen.protobuf.lint.buf", "required": false, "type_hint": "bool" }, { - "alias": "jvm_resolve", - "default": null, - "description": "The resolve from `[jvm].resolves` to use when compiling this target.\n\nIf not defined, will default to `[jvm].default_resolve`.", - "provider": "pants.backend.experimental.codegen.protobuf.java", + "alias": "skip_buf_format", + "default": "False", + "description": "If true, don't run `buf format` on this target's code.", + "provider": "pants.backend.codegen.protobuf.lint.buf", "required": false, - "type_hint": "str | None" + "type_hint": "bool" }, { "alias": "go_mod_address", @@ -90763,21 +90793,13 @@ "type_hint": "str | None" }, { - "alias": "jvm_jdk", + "alias": "jvm_resolve", "default": null, - "description": "The major version of the JDK that this target should be built with. If not defined, will default to `[jvm].default_source_jdk`.", + "description": "The resolve from `[jvm].resolves` to use when compiling this target.\n\nIf not defined, will default to `[jvm].default_resolve`.", "provider": "pants.backend.experimental.codegen.protobuf.java", "required": false, "type_hint": "str | None" }, - { - "alias": "skip_buf_lint", - "default": "False", - "description": "If true, don't run `buf lint` on this target's code.", - "provider": "pants.backend.codegen.protobuf.lint.buf", - "required": false, - "type_hint": "bool" - }, { "alias": "python_resolve", "default": null, @@ -91210,14 +91232,6 @@ "required": false, "type_hint": "str | None" }, - { - "alias": "uses_mypyc", - "default": "False", - "description": "If true, this distribution is built using mypyc.\n\nIn this case, Pants will build the distribution in an environment that includes mypy, as configured in the `[mypy]` subsystem, including plugins, config files, extra type stubs, and the distribution's own requirements (which normally would not be needed at build time, but in this case may provide necessary type annotations).\n\nYou will typically set this field on distributions whose `setup.py` uses `mypyc.build.mypycify()`. See https://mypyc.readthedocs.io/en/latest/index.html .", - "provider": "pants.backend.python.typecheck.mypy", - "required": false, - "type_hint": "bool" - }, { "alias": "repositories", "default": null, @@ -91233,6 +91247,14 @@ "provider": "pants.backend.experimental.python", "required": false, "type_hint": "bool" + }, + { + "alias": "uses_mypyc", + "default": "False", + "description": "If true, this distribution is built using mypyc.\n\nIn this case, Pants will build the distribution in an environment that includes mypy, as configured in the `[mypy]` subsystem, including plugins, config files, extra type stubs, and the distribution's own requirements (which normally would not be needed at build time, but in this case may provide necessary type annotations).\n\nYou will typically set this field on distributions whose `setup.py` uses `mypyc.build.mypycify()`. See https://mypyc.readthedocs.io/en/latest/index.html .", + "provider": "pants.backend.python.typecheck.mypy", + "required": false, + "type_hint": "bool" } ], "provider": "pants.backend.python", @@ -91373,7 +91395,7 @@ { "alias": "modules", "default": null, - "description": "The modules this requirement provides (used for dependency inference).\n\nFor example, the requirement `setuptools` provides `[\"setuptools\", \"pkg_resources\", \"easy_install\"]`.\n\nUsually you can leave this field off. If unspecified, Pants will first look at the default module mapping (https://github.com/pantsbuild/pants/blob/release_2.19.0/src/python/pants/backend/python/dependency_inference/default_module_mapping.py), and then will default to the normalized project name. For example, the requirement `Django` would default to the module `django`.\n\nMutually exclusive with the `type_stub_modules` field.", + "description": "The modules this requirement provides (used for dependency inference).\n\nFor example, the requirement `setuptools` provides `[\"setuptools\", \"pkg_resources\", \"easy_install\"]`.\n\nUsually you can leave this field off. If unspecified, Pants will first look at the default module mapping (https://github.com/pantsbuild/pants/blob/release_2.19.1/src/python/pants/backend/python/dependency_inference/default_module_mapping.py), and then will default to the normalized project name. For example, the requirement `Django` would default to the module `django`.\n\nMutually exclusive with the `type_stub_modules` field.", "provider": "", "required": false, "type_hint": "Iterable[str] | None" @@ -91381,7 +91403,7 @@ { "alias": "type_stub_modules", "default": null, - "description": "The modules this requirement provides if the requirement is a type stub (used for dependency inference).\n\nFor example, the requirement `types-requests` provides `[\"requests\"]`.\n\nUsually you can leave this field off. If unspecified, Pants will first look at the default module mapping (https://github.com/pantsbuild/pants/blob/release_2.19.0/src/python/pants/backend/python/dependency_inference/default_module_mapping.py). If not found _and_ the requirement name starts with `types-` or `stubs-`, or ends with `-types` or `-stubs`, will default to that requirement name without the prefix/suffix. For example, `types-requests` would default to `requests`. Otherwise, will be treated like a normal requirement (see the `modules` field).\n\nMutually exclusive with the `modules` field.", + "description": "The modules this requirement provides if the requirement is a type stub (used for dependency inference).\n\nFor example, the requirement `types-requests` provides `[\"requests\"]`.\n\nUsually you can leave this field off. If unspecified, Pants will first look at the default module mapping (https://github.com/pantsbuild/pants/blob/release_2.19.1/src/python/pants/backend/python/dependency_inference/default_module_mapping.py). If not found _and_ the requirement name starts with `types-` or `stubs-`, or ends with `-types` or `-stubs`, will default to that requirement name without the prefix/suffix. For example, `types-requests` would default to `requests`. Otherwise, will be treated like a normal requirement (see the `modules` field).\n\nMutually exclusive with the `modules` field.", "provider": "", "required": false, "type_hint": "Iterable[str] | None" @@ -91539,66 +91561,66 @@ "type_hint": "bool" }, { - "alias": "skip_pytype", + "alias": "skip_flake8", "default": "False", - "description": "If true, don't run pytype on this target's code.", - "provider": "pants.backend.experimental.python.typecheck.pytype", + "description": "If true, don't run Flake8 on this target's code.", + "provider": "pants.backend.python.lint.flake8", "required": false, "type_hint": "bool" }, { - "alias": "skip_isort", + "alias": "skip_pytype", "default": "False", - "description": "If true, don't run isort on this target's code.", - "provider": "pants.backend.python.lint.isort", + "description": "If true, don't run pytype on this target's code.", + "provider": "pants.backend.experimental.python.typecheck.pytype", "required": false, "type_hint": "bool" }, { - "alias": "skip_mypy", + "alias": "skip_docformatter", "default": "False", - "description": "If true, don't run MyPy on this target's code.", - "provider": "pants.backend.python.typecheck.mypy", + "description": "If true, don't run Docformatter on this target's code.", + "provider": "pants.backend.python.lint.docformatter", "required": false, "type_hint": "bool" }, { - "alias": "skip_pydocstyle", + "alias": "skip_add_trailing_comma", "default": "False", - "description": "If true, don't run pydocstyle on this target's code.", - "provider": "pants.backend.python.lint.pydocstyle", + "description": "If true, don't run add-trailing-comma on this target's code.", + "provider": "pants.backend.experimental.python.lint.add_trailing_comma", "required": false, "type_hint": "bool" }, { - "alias": "skip_ruff", + "alias": "skip_pylint", "default": "False", - "description": "If true, don't run ruff on this target's code.", - "provider": "pants.backend.experimental.python.lint.ruff", + "description": "If true, don't run Pylint on this target's code.", + "provider": "pants.backend.python.lint.pylint", "required": false, "type_hint": "bool" }, { - "alias": "skip_pyupgrade", + "alias": "skip_mypy", "default": "False", - "description": "If true, don't run pyupgrade on this target's code.", - "provider": "pants.backend.python.lint.pyupgrade", + "description": "If true, don't run MyPy on this target's code.", + "provider": "pants.backend.python.typecheck.mypy", "required": false, "type_hint": "bool" }, { - "alias": "skip_pylint", + "alias": "skip_bandit", "default": "False", - "description": "If true, don't run Pylint on this target's code.", - "provider": "pants.backend.python.lint.pylint", + "description": "If true, don't run Bandit on this target's code.", + "provider": "pants.backend.python.lint.bandit", "required": false, "type_hint": "bool" }, { - "alias": "skip_docformatter", + "alias": "skip_yapf", "default": "False", - "description": "If true, don't run Docformatter on this target's code.", - "provider": "pants.backend.python.lint.docformatter", + "description": "If true, don't run yapf on this target's code.", + "provider": "pants.backend.python.lint.yapf", "required": false, "type_hint": "bool" }, @@ -91611,50 +91633,50 @@ "type_hint": "bool" }, { - "alias": "skip_bandit", + "alias": "skip_isort", "default": "False", - "description": "If true, don't run Bandit on this target's code.", - "provider": "pants.backend.python.lint.bandit", + "description": "If true, don't run isort on this target's code.", + "provider": "pants.backend.python.lint.isort", "required": false, "type_hint": "bool" }, { - "alias": "skip_autoflake", + "alias": "skip_pydocstyle", "default": "False", - "description": "If true, don't run Autoflake on this target's code.", - "provider": "pants.backend.python.lint.autoflake", + "description": "If true, don't run pydocstyle on this target's code.", + "provider": "pants.backend.python.lint.pydocstyle", "required": false, "type_hint": "bool" }, { - "alias": "skip_black", + "alias": "skip_pyupgrade", "default": "False", - "description": "If true, don't run Black on this target's code.", - "provider": "pants.backend.python.lint.black", + "description": "If true, don't run pyupgrade on this target's code.", + "provider": "pants.backend.python.lint.pyupgrade", "required": false, "type_hint": "bool" }, { - "alias": "skip_yapf", + "alias": "skip_autoflake", "default": "False", - "description": "If true, don't run yapf on this target's code.", - "provider": "pants.backend.python.lint.yapf", + "description": "If true, don't run Autoflake on this target's code.", + "provider": "pants.backend.python.lint.autoflake", "required": false, "type_hint": "bool" }, { - "alias": "skip_flake8", + "alias": "skip_black", "default": "False", - "description": "If true, don't run Flake8 on this target's code.", - "provider": "pants.backend.python.lint.flake8", + "description": "If true, don't run Black on this target's code.", + "provider": "pants.backend.python.lint.black", "required": false, "type_hint": "bool" }, { - "alias": "skip_add_trailing_comma", + "alias": "skip_ruff", "default": "False", - "description": "If true, don't run add-trailing-comma on this target's code.", - "provider": "pants.backend.experimental.python.lint.add_trailing_comma", + "description": "If true, don't run ruff on this target's code.", + "provider": "pants.backend.experimental.python.lint.ruff", "required": false, "type_hint": "bool" } @@ -91699,66 +91721,66 @@ "type_hint": "Dict[Union[str, Tuple[str, ...]], Dict[str, Any]] | None" }, { - "alias": "skip_pytype", + "alias": "skip_flake8", "default": "False", - "description": "If true, don't run pytype on this target's code.", - "provider": "pants.backend.experimental.python.typecheck.pytype", + "description": "If true, don't run Flake8 on this target's code.", + "provider": "pants.backend.python.lint.flake8", "required": false, "type_hint": "bool" }, { - "alias": "skip_isort", + "alias": "skip_pytype", "default": "False", - "description": "If true, don't run isort on this target's code.", - "provider": "pants.backend.python.lint.isort", + "description": "If true, don't run pytype on this target's code.", + "provider": "pants.backend.experimental.python.typecheck.pytype", "required": false, "type_hint": "bool" }, { - "alias": "skip_mypy", + "alias": "skip_docformatter", "default": "False", - "description": "If true, don't run MyPy on this target's code.", - "provider": "pants.backend.python.typecheck.mypy", + "description": "If true, don't run Docformatter on this target's code.", + "provider": "pants.backend.python.lint.docformatter", "required": false, "type_hint": "bool" }, { - "alias": "skip_pydocstyle", + "alias": "skip_add_trailing_comma", "default": "False", - "description": "If true, don't run pydocstyle on this target's code.", - "provider": "pants.backend.python.lint.pydocstyle", + "description": "If true, don't run add-trailing-comma on this target's code.", + "provider": "pants.backend.experimental.python.lint.add_trailing_comma", "required": false, "type_hint": "bool" }, { - "alias": "skip_ruff", + "alias": "skip_pylint", "default": "False", - "description": "If true, don't run ruff on this target's code.", - "provider": "pants.backend.experimental.python.lint.ruff", + "description": "If true, don't run Pylint on this target's code.", + "provider": "pants.backend.python.lint.pylint", "required": false, "type_hint": "bool" }, { - "alias": "skip_pyupgrade", + "alias": "skip_mypy", "default": "False", - "description": "If true, don't run pyupgrade on this target's code.", - "provider": "pants.backend.python.lint.pyupgrade", + "description": "If true, don't run MyPy on this target's code.", + "provider": "pants.backend.python.typecheck.mypy", "required": false, "type_hint": "bool" }, { - "alias": "skip_pylint", + "alias": "skip_bandit", "default": "False", - "description": "If true, don't run Pylint on this target's code.", - "provider": "pants.backend.python.lint.pylint", + "description": "If true, don't run Bandit on this target's code.", + "provider": "pants.backend.python.lint.bandit", "required": false, "type_hint": "bool" }, { - "alias": "skip_docformatter", + "alias": "skip_yapf", "default": "False", - "description": "If true, don't run Docformatter on this target's code.", - "provider": "pants.backend.python.lint.docformatter", + "description": "If true, don't run yapf on this target's code.", + "provider": "pants.backend.python.lint.yapf", "required": false, "type_hint": "bool" }, @@ -91771,50 +91793,50 @@ "type_hint": "bool" }, { - "alias": "skip_bandit", + "alias": "skip_isort", "default": "False", - "description": "If true, don't run Bandit on this target's code.", - "provider": "pants.backend.python.lint.bandit", + "description": "If true, don't run isort on this target's code.", + "provider": "pants.backend.python.lint.isort", "required": false, "type_hint": "bool" }, { - "alias": "skip_autoflake", + "alias": "skip_pydocstyle", "default": "False", - "description": "If true, don't run Autoflake on this target's code.", - "provider": "pants.backend.python.lint.autoflake", + "description": "If true, don't run pydocstyle on this target's code.", + "provider": "pants.backend.python.lint.pydocstyle", "required": false, "type_hint": "bool" }, { - "alias": "skip_black", + "alias": "skip_pyupgrade", "default": "False", - "description": "If true, don't run Black on this target's code.", - "provider": "pants.backend.python.lint.black", + "description": "If true, don't run pyupgrade on this target's code.", + "provider": "pants.backend.python.lint.pyupgrade", "required": false, "type_hint": "bool" }, { - "alias": "skip_yapf", + "alias": "skip_autoflake", "default": "False", - "description": "If true, don't run yapf on this target's code.", - "provider": "pants.backend.python.lint.yapf", + "description": "If true, don't run Autoflake on this target's code.", + "provider": "pants.backend.python.lint.autoflake", "required": false, "type_hint": "bool" }, { - "alias": "skip_flake8", + "alias": "skip_black", "default": "False", - "description": "If true, don't run Flake8 on this target's code.", - "provider": "pants.backend.python.lint.flake8", + "description": "If true, don't run Black on this target's code.", + "provider": "pants.backend.python.lint.black", "required": false, "type_hint": "bool" }, { - "alias": "skip_add_trailing_comma", + "alias": "skip_ruff", "default": "False", - "description": "If true, don't run add-trailing-comma on this target's code.", - "provider": "pants.backend.experimental.python.lint.add_trailing_comma", + "description": "If true, don't run ruff on this target's code.", + "provider": "pants.backend.experimental.python.lint.ruff", "required": false, "type_hint": "bool" }, @@ -91979,12 +92001,12 @@ "type_hint": "str" }, { - "alias": "stevedore_namespaces", - "default": null, - "description": "List the stevedore namespaces required by this target.\n\nCode for all `entry_points` on `python_distribution` targets with these namespaces will be added as dependencies so that they are available on PYTHONPATH during tests. Note that this is only a subset of the `python_distribution`s dependencies, so the `entry_points` only need to be defined on one `python_distribution` even if the test only needs some of the `entry_points` namespaces on it.\n\nPlus, an `entry_points.txt` file will be generated in the sandbox so that each of the `python_distribution`s appear to be \"installed\". The `entry_points.txt` file will only include the namespaces requested on this field. Without this, stevedore would not be able to look up plugins in the setuptools `entry_points` metadata.\n\nNOTE: Each `python_distribution` must opt-in to being included in this repo-wide inference by tagging the namespaces with `stevedore_namespace(\"my.stevedore.extension\")`.\n\nThe stevedore namespace format (`my.stevedore.extension`) is similar to a Python namespace.", - "provider": "pants.backend.experimental.python.framework.stevedore", + "alias": "skip_flake8", + "default": "False", + "description": "If true, don't run Flake8 on this target's code.", + "provider": "pants.backend.python.lint.flake8", "required": false, - "type_hint": "Iterable[str] | None" + "type_hint": "bool" }, { "alias": "skip_pytype", @@ -91995,58 +92017,58 @@ "type_hint": "bool" }, { - "alias": "skip_isort", - "default": "False", - "description": "If true, don't run isort on this target's code.", - "provider": "pants.backend.python.lint.isort", + "alias": "stevedore_namespaces", + "default": null, + "description": "List the stevedore namespaces required by this target.\n\nCode for all `entry_points` on `python_distribution` targets with these namespaces will be added as dependencies so that they are available on PYTHONPATH during tests. Note that this is only a subset of the `python_distribution`s dependencies, so the `entry_points` only need to be defined on one `python_distribution` even if the test only needs some of the `entry_points` namespaces on it.\n\nPlus, an `entry_points.txt` file will be generated in the sandbox so that each of the `python_distribution`s appear to be \"installed\". The `entry_points.txt` file will only include the namespaces requested on this field. Without this, stevedore would not be able to look up plugins in the setuptools `entry_points` metadata.\n\nNOTE: Each `python_distribution` must opt-in to being included in this repo-wide inference by tagging the namespaces with `stevedore_namespace(\"my.stevedore.extension\")`.\n\nThe stevedore namespace format (`my.stevedore.extension`) is similar to a Python namespace.", + "provider": "pants.backend.experimental.python.framework.stevedore", "required": false, - "type_hint": "bool" + "type_hint": "Iterable[str] | None" }, { - "alias": "skip_mypy", + "alias": "skip_docformatter", "default": "False", - "description": "If true, don't run MyPy on this target's code.", - "provider": "pants.backend.python.typecheck.mypy", + "description": "If true, don't run Docformatter on this target's code.", + "provider": "pants.backend.python.lint.docformatter", "required": false, "type_hint": "bool" }, { - "alias": "skip_pydocstyle", + "alias": "skip_add_trailing_comma", "default": "False", - "description": "If true, don't run pydocstyle on this target's code.", - "provider": "pants.backend.python.lint.pydocstyle", + "description": "If true, don't run add-trailing-comma on this target's code.", + "provider": "pants.backend.experimental.python.lint.add_trailing_comma", "required": false, "type_hint": "bool" }, { - "alias": "skip_ruff", + "alias": "skip_pylint", "default": "False", - "description": "If true, don't run ruff on this target's code.", - "provider": "pants.backend.experimental.python.lint.ruff", + "description": "If true, don't run Pylint on this target's code.", + "provider": "pants.backend.python.lint.pylint", "required": false, "type_hint": "bool" }, { - "alias": "skip_pyupgrade", + "alias": "skip_mypy", "default": "False", - "description": "If true, don't run pyupgrade on this target's code.", - "provider": "pants.backend.python.lint.pyupgrade", + "description": "If true, don't run MyPy on this target's code.", + "provider": "pants.backend.python.typecheck.mypy", "required": false, "type_hint": "bool" }, { - "alias": "skip_pylint", + "alias": "skip_bandit", "default": "False", - "description": "If true, don't run Pylint on this target's code.", - "provider": "pants.backend.python.lint.pylint", + "description": "If true, don't run Bandit on this target's code.", + "provider": "pants.backend.python.lint.bandit", "required": false, "type_hint": "bool" }, { - "alias": "skip_docformatter", + "alias": "skip_yapf", "default": "False", - "description": "If true, don't run Docformatter on this target's code.", - "provider": "pants.backend.python.lint.docformatter", + "description": "If true, don't run yapf on this target's code.", + "provider": "pants.backend.python.lint.yapf", "required": false, "type_hint": "bool" }, @@ -92059,50 +92081,50 @@ "type_hint": "bool" }, { - "alias": "skip_bandit", + "alias": "skip_isort", "default": "False", - "description": "If true, don't run Bandit on this target's code.", - "provider": "pants.backend.python.lint.bandit", + "description": "If true, don't run isort on this target's code.", + "provider": "pants.backend.python.lint.isort", "required": false, "type_hint": "bool" }, { - "alias": "skip_autoflake", + "alias": "skip_pydocstyle", "default": "False", - "description": "If true, don't run Autoflake on this target's code.", - "provider": "pants.backend.python.lint.autoflake", + "description": "If true, don't run pydocstyle on this target's code.", + "provider": "pants.backend.python.lint.pydocstyle", "required": false, "type_hint": "bool" }, { - "alias": "skip_black", + "alias": "skip_pyupgrade", "default": "False", - "description": "If true, don't run Black on this target's code.", - "provider": "pants.backend.python.lint.black", + "description": "If true, don't run pyupgrade on this target's code.", + "provider": "pants.backend.python.lint.pyupgrade", "required": false, "type_hint": "bool" }, { - "alias": "skip_yapf", + "alias": "skip_autoflake", "default": "False", - "description": "If true, don't run yapf on this target's code.", - "provider": "pants.backend.python.lint.yapf", + "description": "If true, don't run Autoflake on this target's code.", + "provider": "pants.backend.python.lint.autoflake", "required": false, "type_hint": "bool" }, { - "alias": "skip_flake8", + "alias": "skip_black", "default": "False", - "description": "If true, don't run Flake8 on this target's code.", - "provider": "pants.backend.python.lint.flake8", + "description": "If true, don't run Black on this target's code.", + "provider": "pants.backend.python.lint.black", "required": false, "type_hint": "bool" }, { - "alias": "skip_add_trailing_comma", + "alias": "skip_ruff", "default": "False", - "description": "If true, don't run add-trailing-comma on this target's code.", - "provider": "pants.backend.experimental.python.lint.add_trailing_comma", + "description": "If true, don't run ruff on this target's code.", + "provider": "pants.backend.experimental.python.lint.ruff", "required": false, "type_hint": "bool" } @@ -92147,66 +92169,66 @@ "type_hint": "Dict[Union[str, Tuple[str, ...]], Dict[str, Any]] | None" }, { - "alias": "skip_pytype", + "alias": "skip_flake8", "default": "False", - "description": "If true, don't run pytype on this target's code.", - "provider": "pants.backend.experimental.python.typecheck.pytype", + "description": "If true, don't run Flake8 on this target's code.", + "provider": "pants.backend.python.lint.flake8", "required": false, "type_hint": "bool" }, { - "alias": "skip_isort", + "alias": "skip_pytype", "default": "False", - "description": "If true, don't run isort on this target's code.", - "provider": "pants.backend.python.lint.isort", + "description": "If true, don't run pytype on this target's code.", + "provider": "pants.backend.experimental.python.typecheck.pytype", "required": false, "type_hint": "bool" }, { - "alias": "skip_mypy", + "alias": "skip_docformatter", "default": "False", - "description": "If true, don't run MyPy on this target's code.", - "provider": "pants.backend.python.typecheck.mypy", + "description": "If true, don't run Docformatter on this target's code.", + "provider": "pants.backend.python.lint.docformatter", "required": false, "type_hint": "bool" }, { - "alias": "skip_pydocstyle", + "alias": "skip_add_trailing_comma", "default": "False", - "description": "If true, don't run pydocstyle on this target's code.", - "provider": "pants.backend.python.lint.pydocstyle", + "description": "If true, don't run add-trailing-comma on this target's code.", + "provider": "pants.backend.experimental.python.lint.add_trailing_comma", "required": false, "type_hint": "bool" }, { - "alias": "skip_ruff", + "alias": "skip_pylint", "default": "False", - "description": "If true, don't run ruff on this target's code.", - "provider": "pants.backend.experimental.python.lint.ruff", + "description": "If true, don't run Pylint on this target's code.", + "provider": "pants.backend.python.lint.pylint", "required": false, "type_hint": "bool" }, { - "alias": "skip_pyupgrade", + "alias": "skip_mypy", "default": "False", - "description": "If true, don't run pyupgrade on this target's code.", - "provider": "pants.backend.python.lint.pyupgrade", + "description": "If true, don't run MyPy on this target's code.", + "provider": "pants.backend.python.typecheck.mypy", "required": false, "type_hint": "bool" }, { - "alias": "skip_pylint", + "alias": "skip_bandit", "default": "False", - "description": "If true, don't run Pylint on this target's code.", - "provider": "pants.backend.python.lint.pylint", + "description": "If true, don't run Bandit on this target's code.", + "provider": "pants.backend.python.lint.bandit", "required": false, "type_hint": "bool" }, { - "alias": "skip_docformatter", + "alias": "skip_yapf", "default": "False", - "description": "If true, don't run Docformatter on this target's code.", - "provider": "pants.backend.python.lint.docformatter", + "description": "If true, don't run yapf on this target's code.", + "provider": "pants.backend.python.lint.yapf", "required": false, "type_hint": "bool" }, @@ -92219,50 +92241,50 @@ "type_hint": "bool" }, { - "alias": "skip_bandit", + "alias": "skip_isort", "default": "False", - "description": "If true, don't run Bandit on this target's code.", - "provider": "pants.backend.python.lint.bandit", + "description": "If true, don't run isort on this target's code.", + "provider": "pants.backend.python.lint.isort", "required": false, "type_hint": "bool" }, { - "alias": "skip_autoflake", + "alias": "skip_pydocstyle", "default": "False", - "description": "If true, don't run Autoflake on this target's code.", - "provider": "pants.backend.python.lint.autoflake", + "description": "If true, don't run pydocstyle on this target's code.", + "provider": "pants.backend.python.lint.pydocstyle", "required": false, "type_hint": "bool" }, { - "alias": "skip_black", + "alias": "skip_pyupgrade", "default": "False", - "description": "If true, don't run Black on this target's code.", - "provider": "pants.backend.python.lint.black", + "description": "If true, don't run pyupgrade on this target's code.", + "provider": "pants.backend.python.lint.pyupgrade", "required": false, "type_hint": "bool" }, { - "alias": "skip_yapf", + "alias": "skip_autoflake", "default": "False", - "description": "If true, don't run yapf on this target's code.", - "provider": "pants.backend.python.lint.yapf", + "description": "If true, don't run Autoflake on this target's code.", + "provider": "pants.backend.python.lint.autoflake", "required": false, "type_hint": "bool" }, { - "alias": "skip_flake8", + "alias": "skip_black", "default": "False", - "description": "If true, don't run Flake8 on this target's code.", - "provider": "pants.backend.python.lint.flake8", + "description": "If true, don't run Black on this target's code.", + "provider": "pants.backend.python.lint.black", "required": false, "type_hint": "bool" }, { - "alias": "skip_add_trailing_comma", + "alias": "skip_ruff", "default": "False", - "description": "If true, don't run add-trailing-comma on this target's code.", - "provider": "pants.backend.experimental.python.lint.add_trailing_comma", + "description": "If true, don't run ruff on this target's code.", + "provider": "pants.backend.experimental.python.lint.ruff", "required": false, "type_hint": "bool" }, @@ -92339,12 +92361,12 @@ "type_hint": "Dict[Union[str, Tuple[str, ...]], Dict[str, Any]] | None" }, { - "alias": "stevedore_namespaces", - "default": null, - "description": "List the stevedore namespaces required by this target.\n\nCode for all `entry_points` on `python_distribution` targets with these namespaces will be added as dependencies so that they are available on PYTHONPATH during tests. Note that this is only a subset of the `python_distribution`s dependencies, so the `entry_points` only need to be defined on one `python_distribution` even if the test only needs some of the `entry_points` namespaces on it.\n\nPlus, an `entry_points.txt` file will be generated in the sandbox so that each of the `python_distribution`s appear to be \"installed\". The `entry_points.txt` file will only include the namespaces requested on this field. Without this, stevedore would not be able to look up plugins in the setuptools `entry_points` metadata.\n\nNOTE: Each `python_distribution` must opt-in to being included in this repo-wide inference by tagging the namespaces with `stevedore_namespace(\"my.stevedore.extension\")`.\n\nThe stevedore namespace format (`my.stevedore.extension`) is similar to a Python namespace.", - "provider": "pants.backend.experimental.python.framework.stevedore", + "alias": "skip_flake8", + "default": "False", + "description": "If true, don't run Flake8 on this target's code.", + "provider": "pants.backend.python.lint.flake8", "required": false, - "type_hint": "Iterable[str] | None" + "type_hint": "bool" }, { "alias": "skip_pytype", @@ -92355,58 +92377,58 @@ "type_hint": "bool" }, { - "alias": "skip_isort", - "default": "False", - "description": "If true, don't run isort on this target's code.", - "provider": "pants.backend.python.lint.isort", + "alias": "stevedore_namespaces", + "default": null, + "description": "List the stevedore namespaces required by this target.\n\nCode for all `entry_points` on `python_distribution` targets with these namespaces will be added as dependencies so that they are available on PYTHONPATH during tests. Note that this is only a subset of the `python_distribution`s dependencies, so the `entry_points` only need to be defined on one `python_distribution` even if the test only needs some of the `entry_points` namespaces on it.\n\nPlus, an `entry_points.txt` file will be generated in the sandbox so that each of the `python_distribution`s appear to be \"installed\". The `entry_points.txt` file will only include the namespaces requested on this field. Without this, stevedore would not be able to look up plugins in the setuptools `entry_points` metadata.\n\nNOTE: Each `python_distribution` must opt-in to being included in this repo-wide inference by tagging the namespaces with `stevedore_namespace(\"my.stevedore.extension\")`.\n\nThe stevedore namespace format (`my.stevedore.extension`) is similar to a Python namespace.", + "provider": "pants.backend.experimental.python.framework.stevedore", "required": false, - "type_hint": "bool" + "type_hint": "Iterable[str] | None" }, { - "alias": "skip_mypy", + "alias": "skip_docformatter", "default": "False", - "description": "If true, don't run MyPy on this target's code.", - "provider": "pants.backend.python.typecheck.mypy", + "description": "If true, don't run Docformatter on this target's code.", + "provider": "pants.backend.python.lint.docformatter", "required": false, "type_hint": "bool" }, { - "alias": "skip_pydocstyle", + "alias": "skip_add_trailing_comma", "default": "False", - "description": "If true, don't run pydocstyle on this target's code.", - "provider": "pants.backend.python.lint.pydocstyle", + "description": "If true, don't run add-trailing-comma on this target's code.", + "provider": "pants.backend.experimental.python.lint.add_trailing_comma", "required": false, "type_hint": "bool" }, { - "alias": "skip_ruff", + "alias": "skip_pylint", "default": "False", - "description": "If true, don't run ruff on this target's code.", - "provider": "pants.backend.experimental.python.lint.ruff", + "description": "If true, don't run Pylint on this target's code.", + "provider": "pants.backend.python.lint.pylint", "required": false, "type_hint": "bool" }, { - "alias": "skip_pyupgrade", + "alias": "skip_mypy", "default": "False", - "description": "If true, don't run pyupgrade on this target's code.", - "provider": "pants.backend.python.lint.pyupgrade", + "description": "If true, don't run MyPy on this target's code.", + "provider": "pants.backend.python.typecheck.mypy", "required": false, "type_hint": "bool" }, { - "alias": "skip_pylint", + "alias": "skip_bandit", "default": "False", - "description": "If true, don't run Pylint on this target's code.", - "provider": "pants.backend.python.lint.pylint", + "description": "If true, don't run Bandit on this target's code.", + "provider": "pants.backend.python.lint.bandit", "required": false, "type_hint": "bool" }, { - "alias": "skip_docformatter", + "alias": "skip_yapf", "default": "False", - "description": "If true, don't run Docformatter on this target's code.", - "provider": "pants.backend.python.lint.docformatter", + "description": "If true, don't run yapf on this target's code.", + "provider": "pants.backend.python.lint.yapf", "required": false, "type_hint": "bool" }, @@ -92419,50 +92441,50 @@ "type_hint": "bool" }, { - "alias": "skip_bandit", + "alias": "skip_isort", "default": "False", - "description": "If true, don't run Bandit on this target's code.", - "provider": "pants.backend.python.lint.bandit", + "description": "If true, don't run isort on this target's code.", + "provider": "pants.backend.python.lint.isort", "required": false, "type_hint": "bool" }, { - "alias": "skip_autoflake", + "alias": "skip_pydocstyle", "default": "False", - "description": "If true, don't run Autoflake on this target's code.", - "provider": "pants.backend.python.lint.autoflake", + "description": "If true, don't run pydocstyle on this target's code.", + "provider": "pants.backend.python.lint.pydocstyle", "required": false, "type_hint": "bool" }, { - "alias": "skip_black", + "alias": "skip_pyupgrade", "default": "False", - "description": "If true, don't run Black on this target's code.", - "provider": "pants.backend.python.lint.black", + "description": "If true, don't run pyupgrade on this target's code.", + "provider": "pants.backend.python.lint.pyupgrade", "required": false, "type_hint": "bool" }, { - "alias": "skip_yapf", + "alias": "skip_autoflake", "default": "False", - "description": "If true, don't run yapf on this target's code.", - "provider": "pants.backend.python.lint.yapf", + "description": "If true, don't run Autoflake on this target's code.", + "provider": "pants.backend.python.lint.autoflake", "required": false, "type_hint": "bool" }, { - "alias": "skip_flake8", + "alias": "skip_black", "default": "False", - "description": "If true, don't run Flake8 on this target's code.", - "provider": "pants.backend.python.lint.flake8", + "description": "If true, don't run Black on this target's code.", + "provider": "pants.backend.python.lint.black", "required": false, "type_hint": "bool" }, { - "alias": "skip_add_trailing_comma", + "alias": "skip_ruff", "default": "False", - "description": "If true, don't run add-trailing-comma on this target's code.", - "provider": "pants.backend.experimental.python.lint.add_trailing_comma", + "description": "If true, don't run ruff on this target's code.", + "provider": "pants.backend.experimental.python.lint.ruff", "required": false, "type_hint": "bool" }, @@ -92658,6 +92680,14 @@ "required": false, "type_hint": "bool" }, + { + "alias": "subprocess_environment_env_vars", + "default": null, + "description": "Overrides the default value from the option `[subprocess-environment].env_vars` when this environment target is active.", + "provider": "pants.core", + "required": false, + "type_hint": "Iterable[str] | None" + }, { "alias": "golang_cgo_tool_search_paths", "default": null, @@ -92667,18 +92697,18 @@ "type_hint": "Iterable[str] | None" }, { - "alias": "golang_subprocess_env_vars", + "alias": "jvm_global_options", "default": null, - "description": "Overrides the default value from the option `[golang].subprocess_env_vars` when this environment target is active.", - "provider": "pants.backend.experimental.go", + "description": "Overrides the default value from the option `[jvm].global_options` when this environment target is active.", + "provider": "pants.backend.experimental.java", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "golang_cgo_c_flags", + "alias": "pex_executable_search_paths", "default": null, - "description": "Overrides the default value from the option `[golang].cgo_c_flags` when this environment target is active.", - "provider": "pants.backend.experimental.go", + "description": "Overrides the default value from the option `[pex].executable_search_paths` when this environment target is active.", + "provider": "pants.core", "required": false, "type_hint": "Iterable[str] | None" }, @@ -92691,114 +92721,114 @@ "type_hint": "str | None" }, { - "alias": "docker_env_vars", + "alias": "shell_setup_executable_search_paths", "default": null, - "description": "Overrides the default value from the option `[docker].env_vars` when this environment target is active.", - "provider": "pants.backend.docker", + "description": "Overrides the default value from the option `[shell-setup].executable_search_paths` when this environment target is active.", + "provider": "pants.backend.shell", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "python_bootstrap_search_path", + "alias": "python_native_code_ld_flags", "default": null, - "description": "Overrides the default value from the option `[python-bootstrap].search_path` when this environment target is active.", + "description": "Overrides the default value from the option `[python-native-code].ld_flags` when this environment target is active.", "provider": "pants.core", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "golang_go_search_paths", + "alias": "golang_cgo_gcc_binary_name", "default": null, - "description": "Overrides the default value from the option `[golang].go_search_paths` when this environment target is active.", + "description": "Overrides the default value from the option `[golang].cgo_gcc_binary_name` when this environment target is active.", "provider": "pants.backend.experimental.go", "required": false, - "type_hint": "Iterable[str] | None" + "type_hint": "str | None" }, { - "alias": "shell_setup_executable_search_paths", + "alias": "python_bootstrap_names", "default": null, - "description": "Overrides the default value from the option `[shell-setup].executable_search_paths` when this environment target is active.", - "provider": "pants.backend.shell", + "description": "Overrides the default value from the option `[python-bootstrap].names` when this environment target is active.", + "provider": "pants.core", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "nodejs_search_path", + "alias": "go_generate_env_vars", "default": null, - "description": "Overrides the default value from the option `[nodejs].search_path` when this environment target is active.", - "provider": "pants.backend.experimental.javascript", + "description": "Overrides the default value from the option `[go-generate].env_vars` when this environment target is active.", + "provider": "pants.backend.experimental.go", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "python_native_code_cpp_flags", + "alias": "golang_go_search_paths", "default": null, - "description": "Overrides the default value from the option `[python-native-code].cpp_flags` when this environment target is active.", - "provider": "pants.core", + "description": "Overrides the default value from the option `[golang].go_search_paths` when this environment target is active.", + "provider": "pants.backend.experimental.go", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "test_extra_env_vars", + "alias": "nodejs_corepack_env_vars", "default": null, - "description": "Overrides the default value from the option `[test].extra_env_vars` when this environment target is active.", - "provider": "pants.core", + "description": "Overrides the default value from the option `[nodejs].corepack_env_vars` when this environment target is active.", + "provider": "pants.backend.experimental.javascript", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "python_bootstrap_names", + "alias": "docker_executable_search_paths", "default": null, - "description": "Overrides the default value from the option `[python-bootstrap].names` when this environment target is active.", - "provider": "pants.core", + "description": "Overrides the default value from the option `[docker].executable_search_paths` when this environment target is active.", + "provider": "pants.backend.docker", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "golang_cgo_fortran_flags", + "alias": "golang_cgo_linker_flags", "default": null, - "description": "Overrides the default value from the option `[golang].cgo_fortran_flags` when this environment target is active.", + "description": "Overrides the default value from the option `[golang].cgo_linker_flags` when this environment target is active.", "provider": "pants.backend.experimental.go", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "golang_cgo_linker_flags", + "alias": "golang_cgo_fortran_flags", "default": null, - "description": "Overrides the default value from the option `[golang].cgo_linker_flags` when this environment target is active.", + "description": "Overrides the default value from the option `[golang].cgo_fortran_flags` when this environment target is active.", "provider": "pants.backend.experimental.go", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "system_binaries_system_binary_paths", + "alias": "apache_thrift_thrift_search_paths", "default": null, - "description": "Overrides the default value from the option `[system-binaries].system_binary_paths` when this environment target is active.", - "provider": "pants.core", + "description": "Overrides the default value from the option `[apache-thrift].thrift_search_paths` when this environment target is active.", + "provider": "pants.backend.codegen.thrift.apache.python", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "go_generate_env_vars", + "alias": "nodejs_executable_search_paths", "default": null, - "description": "Overrides the default value from the option `[go-generate].env_vars` when this environment target is active.", - "provider": "pants.backend.experimental.go", + "description": "Overrides the default value from the option `[nodejs].executable_search_paths` when this environment target is active.", + "provider": "pants.backend.experimental.javascript", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "golang_cgo_gcc_binary_name", + "alias": "golang_cgo_c_flags", "default": null, - "description": "Overrides the default value from the option `[golang].cgo_gcc_binary_name` when this environment target is active.", + "description": "Overrides the default value from the option `[golang].cgo_c_flags` when this environment target is active.", "provider": "pants.backend.experimental.go", "required": false, - "type_hint": "str | None" + "type_hint": "Iterable[str] | None" }, { - "alias": "python_native_code_ld_flags", + "alias": "pyenv_python_provider_installation_extra_env_vars", "default": null, - "description": "Overrides the default value from the option `[python-native-code].ld_flags` when this environment target is active.", - "provider": "pants.core", + "description": "Overrides the default value from the option `[pyenv-python-provider].installation_extra_env_vars` when this environment target is active.", + "provider": "pants.backend.python.providers.experimental.pyenv", "required": false, "type_hint": "Iterable[str] | None" }, @@ -92811,82 +92841,74 @@ "type_hint": "str | None" }, { - "alias": "golang_cgo_gxx_binary_name", - "default": null, - "description": "Overrides the default value from the option `[golang].cgo_gxx_binary_name` when this environment target is active.", - "provider": "pants.backend.experimental.go", - "required": false, - "type_hint": "str | None" - }, - { - "alias": "jvm_global_options", + "alias": "python_native_code_cpp_flags", "default": null, - "description": "Overrides the default value from the option `[jvm].global_options` when this environment target is active.", - "provider": "pants.backend.experimental.java", + "description": "Overrides the default value from the option `[python-native-code].cpp_flags` when this environment target is active.", + "provider": "pants.core", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "docker_executable_search_paths", + "alias": "python_bootstrap_search_path", "default": null, - "description": "Overrides the default value from the option `[docker].executable_search_paths` when this environment target is active.", - "provider": "pants.backend.docker", + "description": "Overrides the default value from the option `[python-bootstrap].search_path` when this environment target is active.", + "provider": "pants.core", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "nodejs_corepack_env_vars", + "alias": "golang_cgo_gxx_binary_name", "default": null, - "description": "Overrides the default value from the option `[nodejs].corepack_env_vars` when this environment target is active.", - "provider": "pants.backend.experimental.javascript", + "description": "Overrides the default value from the option `[golang].cgo_gxx_binary_name` when this environment target is active.", + "provider": "pants.backend.experimental.go", "required": false, - "type_hint": "Iterable[str] | None" + "type_hint": "str | None" }, { - "alias": "apache_thrift_thrift_search_paths", + "alias": "golang_subprocess_env_vars", "default": null, - "description": "Overrides the default value from the option `[apache-thrift].thrift_search_paths` when this environment target is active.", - "provider": "pants.backend.codegen.thrift.apache.python", + "description": "Overrides the default value from the option `[golang].subprocess_env_vars` when this environment target is active.", + "provider": "pants.backend.experimental.go", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "nodejs_executable_search_paths", + "alias": "system_binaries_system_binary_paths", "default": null, - "description": "Overrides the default value from the option `[nodejs].executable_search_paths` when this environment target is active.", - "provider": "pants.backend.experimental.javascript", + "description": "Overrides the default value from the option `[system-binaries].system_binary_paths` when this environment target is active.", + "provider": "pants.core", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "pex_executable_search_paths", + "alias": "docker_env_vars", "default": null, - "description": "Overrides the default value from the option `[pex].executable_search_paths` when this environment target is active.", - "provider": "pants.core", + "description": "Overrides the default value from the option `[docker].env_vars` when this environment target is active.", + "provider": "pants.backend.docker", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "subprocess_environment_env_vars", + "alias": "nodejs_search_path", "default": null, - "description": "Overrides the default value from the option `[subprocess-environment].env_vars` when this environment target is active.", - "provider": "pants.core", + "description": "Overrides the default value from the option `[nodejs].search_path` when this environment target is active.", + "provider": "pants.backend.experimental.javascript", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "pyenv_python_provider_installation_extra_env_vars", + "alias": "golang_cgo_cxx_flags", "default": null, - "description": "Overrides the default value from the option `[pyenv-python-provider].installation_extra_env_vars` when this environment target is active.", - "provider": "pants.backend.python.providers.experimental.pyenv", + "description": "Overrides the default value from the option `[golang].cgo_cxx_flags` when this environment target is active.", + "provider": "pants.backend.experimental.go", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "golang_cgo_cxx_flags", + "alias": "test_extra_env_vars", "default": null, - "description": "Overrides the default value from the option `[golang].cgo_cxx_flags` when this environment target is active.", - "provider": "pants.backend.experimental.go", + "description": "Overrides the default value from the option `[test].extra_env_vars` when this environment target is active.", + "provider": "pants.core", "required": false, "type_hint": "Iterable[str] | None" } @@ -93125,7 +93147,7 @@ { "alias": "packages", "default": null, - "description": "The JVM packages this artifact provides for the purposes of dependency inference.\n\nFor example, the JVM artifact `junit:junit` might provide `[\"org.junit.**\"]`.\n\nUsually you can leave this field off. If unspecified, Pants will fall back to the `[java-infer].third_party_import_mapping`, then to a built in mapping (https://github.com/pantsbuild/pants/blob/release_2.19.0/src/python/pants/jvm/dependency_inference/jvm_artifact_mappings.py), and then finally it will default to the normalized `group` of the artifact. For example, in the absence of any other mapping the artifact `io.confluent:common-config` would default to providing `[\"io.confluent.**\"]`.\n\nThe package path may be made recursive to match symbols in subpackages by adding `.**` to the end of the package path. For example, specify `[\"org.junit.**\"]` to infer a dependency on the artifact for any file importing a symbol from `org.junit` or its subpackages.", + "description": "The JVM packages this artifact provides for the purposes of dependency inference.\n\nFor example, the JVM artifact `junit:junit` might provide `[\"org.junit.**\"]`.\n\nUsually you can leave this field off. If unspecified, Pants will fall back to the `[java-infer].third_party_import_mapping`, then to a built in mapping (https://github.com/pantsbuild/pants/blob/release_2.19.1/src/python/pants/jvm/dependency_inference/jvm_artifact_mappings.py), and then finally it will default to the normalized `group` of the artifact. For example, in the absence of any other mapping the artifact `io.confluent:common-config` would default to providing `[\"io.confluent.**\"]`.\n\nThe package path may be made recursive to match symbols in subpackages by adding `.**` to the end of the package path. For example, specify `[\"org.junit.**\"]` to infer a dependency on the artifact for any file importing a symbol from `org.junit` or its subpackages.", "provider": "", "required": false, "type_hint": "Iterable[str] | None" @@ -94507,18 +94529,18 @@ "type_hint": "Iterable[str] | None" }, { - "alias": "skip_terraform_validate", + "alias": "skip_tfsec", "default": "False", - "description": "If true, don't run `terraform validate` on this target's code. If this target is a module, `terraform validate might still be run on a `terraform_deployment that references this module.", - "provider": "pants.backend.experimental.terraform", + "description": "If true, don't run tfsec on this target's Terraform files.", + "provider": "pants.backend.experimental.terraform.lint.tfsec", "required": false, "type_hint": "bool" }, { - "alias": "skip_tfsec", + "alias": "skip_terraform_validate", "default": "False", - "description": "If true, don't run tfsec on this target's Terraform files.", - "provider": "pants.backend.experimental.terraform.lint.tfsec", + "description": "If true, don't run `terraform validate` on this target's code. If this target is a module, `terraform validate might still be run on a `terraform_deployment that references this module.", + "provider": "pants.backend.experimental.terraform", "required": false, "type_hint": "bool" } @@ -94563,9 +94585,17 @@ "type_hint": "str" }, { - "alias": "jvm_resolve", + "alias": "finagle", + "default": "False", + "description": "If True, then also generate Finagle classes for services when using Scrooge as the Thrift generator.", + "provider": "pants.backend.experimental.codegen.thrift.scrooge.java", + "required": false, + "type_hint": "bool" + }, + { + "alias": "jvm_jdk", "default": null, - "description": "The resolve from `[jvm].resolves` to use when compiling this target.\n\nIf not defined, will default to `[jvm].default_resolve`.", + "description": "The major version of the JDK that this target should be built with. If not defined, will default to `[jvm].default_source_jdk`.", "provider": "pants.backend.experimental.codegen.thrift.apache.java", "required": false, "type_hint": "str | None" @@ -94579,20 +94609,12 @@ "type_hint": "str | None" }, { - "alias": "jvm_jdk", + "alias": "jvm_resolve", "default": null, - "description": "The major version of the JDK that this target should be built with. If not defined, will default to `[jvm].default_source_jdk`.", + "description": "The resolve from `[jvm].resolves` to use when compiling this target.\n\nIf not defined, will default to `[jvm].default_resolve`.", "provider": "pants.backend.experimental.codegen.thrift.apache.java", "required": false, "type_hint": "str | None" - }, - { - "alias": "finagle", - "default": "False", - "description": "If True, then also generate Finagle classes for services when using Scrooge as the Thrift generator.", - "provider": "pants.backend.experimental.codegen.thrift.scrooge.java", - "required": false, - "type_hint": "bool" } ], "provider": "pants.backend.codegen.thrift.apache.python", @@ -94635,9 +94657,17 @@ "type_hint": "Dict[Union[str, Tuple[str, ...]], Dict[str, Any]] | None" }, { - "alias": "jvm_resolve", + "alias": "finagle", + "default": "False", + "description": "If True, then also generate Finagle classes for services when using Scrooge as the Thrift generator.", + "provider": "pants.backend.experimental.codegen.thrift.scrooge.java", + "required": false, + "type_hint": "bool" + }, + { + "alias": "jvm_jdk", "default": null, - "description": "The resolve from `[jvm].resolves` to use when compiling this target.\n\nIf not defined, will default to `[jvm].default_resolve`.", + "description": "The major version of the JDK that this target should be built with. If not defined, will default to `[jvm].default_source_jdk`.", "provider": "pants.backend.experimental.codegen.thrift.apache.java", "required": false, "type_hint": "str | None" @@ -94651,21 +94681,13 @@ "type_hint": "str | None" }, { - "alias": "jvm_jdk", + "alias": "jvm_resolve", "default": null, - "description": "The major version of the JDK that this target should be built with. If not defined, will default to `[jvm].default_source_jdk`.", + "description": "The resolve from `[jvm].resolves` to use when compiling this target.\n\nIf not defined, will default to `[jvm].default_resolve`.", "provider": "pants.backend.experimental.codegen.thrift.apache.java", "required": false, "type_hint": "str | None" }, - { - "alias": "finagle", - "default": "False", - "description": "If True, then also generate Finagle classes for services when using Scrooge as the Thrift generator.", - "provider": "pants.backend.experimental.codegen.thrift.scrooge.java", - "required": false, - "type_hint": "bool" - }, { "alias": "dependencies", "default": null, @@ -95143,12 +95165,12 @@ { "details": null, "rank": "HARDCODED", - "value": "2.19.0" + "value": "2.19.1" }, { "details": "from env var PANTS_VERSION", "rank": "ENVIRONMENT", - "value": "2.19.0" + "value": "2.19.1" } ] } @@ -96884,7 +96906,7 @@ "details": "", "rank": "HARDCODED", "value": { - "user-agent": "pants/2.19.0" + "user-agent": "pants/2.19.1" } } ] @@ -97275,7 +97297,7 @@ "details": "", "rank": "HARDCODED", "value": { - "user-agent": "pants/2.19.0" + "user-agent": "pants/2.19.1" } } ] @@ -106356,7 +106378,7 @@ } ], "deprecated_scope": null, - "description": "Export Pants data for use in other tools, such as IDEs.", + "description": "Export Pants data for use in other tools, such as IDEs.\n\n:::caution Exporting tools requires creating a custom lockfile for them Follow [the instructions for creating tool lockfiles](../../docs/python/overview/lockfiles#lockfiles-for-tools) :::", "is_goal": true, "provider": "pants.core", "scope": "export" @@ -109714,7 +109736,7 @@ ], "env_var": "PANTS_GOOGLE_JAVA_FORMAT_LOCKFILE", "fromfile": false, - "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.19.0/src/python/pants/backend/java/lint/google_java_format/google_java_format.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=google-java-format`.", + "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.19.1/src/python/pants/backend/java/lint/google_java_format/google_java_format.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=google-java-format`.", "removal_hint": null, "removal_version": null, "scoped_cmd_line_args": [ @@ -112341,7 +112363,7 @@ ], "env_var": "PANTS_JARJAR_LOCKFILE", "fromfile": false, - "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.19.0/src/python/pants/jvm/shading/jarjar.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=jarjar`.", + "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.19.1/src/python/pants/jvm/shading/jarjar.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=jarjar`.", "removal_hint": null, "removal_version": null, "scoped_cmd_line_args": [ @@ -112593,7 +112615,7 @@ ], "env_var": "PANTS_JAVA_AVRO_LOCKFILE", "fromfile": false, - "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.19.0/src/python/pants/backend/codegen/avro/java/avro-tools.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=java-avro`.", + "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.19.1/src/python/pants/backend/codegen/avro/java/avro-tools.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=java-avro`.", "removal_hint": null, "removal_version": null, "scoped_cmd_line_args": [ @@ -113052,7 +113074,7 @@ ], "env_var": "PANTS_JUNIT_LOCKFILE", "fromfile": false, - "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.19.0/src/python/pants/jvm/test/junit.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=junit`.", + "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.19.1/src/python/pants/jvm/test/junit.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=junit`.", "removal_hint": null, "removal_version": null, "scoped_cmd_line_args": [ @@ -113929,7 +113951,7 @@ ], "env_var": "PANTS_KTLINT_LOCKFILE", "fromfile": false, - "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.19.0/src/python/pants/backend/kotlin/lint/ktlint/ktlint.lock for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=ktlint`.", + "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.19.1/src/python/pants/backend/kotlin/lint/ktlint/ktlint.lock for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=ktlint`.", "removal_hint": null, "removal_version": null, "scoped_cmd_line_args": [ @@ -116271,7 +116293,7 @@ ], "env_var": "PANTS_OPENAPI_GENERATOR_LOCKFILE", "fromfile": false, - "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.19.0/src/python/pants/backend/openapi/subsystems/openapi_generator.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=openapi-generator`.", + "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.19.1/src/python/pants/backend/openapi/subsystems/openapi_generator.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=openapi-generator`.", "removal_hint": null, "removal_version": null, "scoped_cmd_line_args": [ @@ -117395,7 +117417,7 @@ ], "env_var": "PANTS_PROTOBUF_JAVA_GRPC_LOCKFILE", "fromfile": false, - "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.19.0/src/python/pants/backend/codegen/protobuf/java/grpc-java.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=protobuf-java-grpc`.", + "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.19.1/src/python/pants/backend/codegen/protobuf/java/grpc-java.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=protobuf-java-grpc`.", "removal_hint": null, "removal_version": null, "scoped_cmd_line_args": [ @@ -118158,7 +118180,7 @@ ], "env_var": "PANTS_PYDOCSTYLE_CONFIG_DISCOVERY", "fromfile": false, - "help": "If true, Pants will include any relevant config files during runs (`setup.cfg`, `tox.ini`, `.pydocstyle`, `.pydocstyle.ini`, `.pydocstylerc`, `.pydocstylerc.ini`, and `pyproject.toml`) searching for the configuration file in this particular order.\n\nPlease note that even though `pydocstyle` keeps looking for a configuration file up the directory tree until one is found, Pants will only search for the config files in the repository root (from where you would normally run the `` command).\n\nUse `[pydocstyle].config` instead if your config is in a non-standard location.", + "help": "If true, Pants will include any relevant config files during runs (`setup.cfg`, `tox.ini`, `.pydocstyle`, `.pydocstyle.ini`, `.pydocstylerc`, `.pydocstylerc.ini`, and `pyproject.toml`) searching for the configuration file in this particular order.\n\nPlease note that even though `pydocstyle` keeps looking for a configuration file up the directory tree until one is found, Pants will only search for the config files in the repository root (from where you would normally run the `pants` command).\n\nUse `[pydocstyle].config` instead if your config is in a non-standard location.", "removal_hint": null, "removal_version": null, "scoped_cmd_line_args": [ @@ -123988,7 +124010,7 @@ ], "env_var": "PANTS_SCALAFMT_LOCKFILE", "fromfile": false, - "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.19.0/src/python/pants/backend/scala/lint/scalafmt/scalafmt.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=scalafmt`.", + "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.19.1/src/python/pants/backend/scala/lint/scalafmt/scalafmt.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=scalafmt`.", "removal_hint": null, "removal_version": null, "scoped_cmd_line_args": [ @@ -124201,7 +124223,7 @@ ], "env_var": "PANTS_SCALAPB_LOCKFILE", "fromfile": false, - "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.19.0/src/python/pants/backend/codegen/protobuf/scala/scalapbc.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=scalapb`.", + "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.19.1/src/python/pants/backend/codegen/protobuf/scala/scalapbc.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=scalapb`.", "removal_hint": null, "removal_version": null, "scoped_cmd_line_args": [ @@ -124412,7 +124434,7 @@ ], "env_var": "PANTS_SCALATEST_LOCKFILE", "fromfile": false, - "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.19.0/src/python/pants/backend/scala/subsystems/scalatest.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=scalatest`.", + "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.19.1/src/python/pants/backend/scala/subsystems/scalatest.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=scalatest`.", "removal_hint": null, "removal_version": null, "scoped_cmd_line_args": [ @@ -124935,7 +124957,7 @@ ], "env_var": "PANTS_SCROOGE_LOCKFILE", "fromfile": false, - "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.19.0/src/python/pants/backend/codegen/thrift/scrooge/scrooge.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=scrooge`.", + "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.19.1/src/python/pants/backend/codegen/thrift/scrooge/scrooge.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=scrooge`.", "removal_hint": null, "removal_version": null, "scoped_cmd_line_args": [ diff --git a/versioned_docs/version-2.19/reference/subsystems/google-java-format.mdx b/versioned_docs/version-2.19/reference/subsystems/google-java-format.mdx index f0c0917aa..21cf65358 100644 --- a/versioned_docs/version-2.19/reference/subsystems/google-java-format.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/google-java-format.mdx @@ -99,7 +99,7 @@ lockfile = `} Path to a lockfile used for installing the tool. -Set to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.19.0/src/python/pants/backend/java/lint/google_java_format/google_java_format.default.lockfile.txt for the default lockfile contents. +Set to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.19.1/src/python/pants/backend/java/lint/google_java_format/google_java_format.default.lockfile.txt for the default lockfile contents. To use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=google-java-format`. diff --git a/versioned_docs/version-2.19/reference/subsystems/jarjar.mdx b/versioned_docs/version-2.19/reference/subsystems/jarjar.mdx index a9323f254..a0c78c78a 100644 --- a/versioned_docs/version-2.19/reference/subsystems/jarjar.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/jarjar.mdx @@ -100,7 +100,7 @@ lockfile = `} Path to a lockfile used for installing the tool. -Set to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.19.0/src/python/pants/jvm/shading/jarjar.default.lockfile.txt for the default lockfile contents. +Set to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.19.1/src/python/pants/jvm/shading/jarjar.default.lockfile.txt for the default lockfile contents. To use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=jarjar`. diff --git a/versioned_docs/version-2.19/reference/subsystems/java-avro.mdx b/versioned_docs/version-2.19/reference/subsystems/java-avro.mdx index dcab96dc3..f7fc989bc 100644 --- a/versioned_docs/version-2.19/reference/subsystems/java-avro.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/java-avro.mdx @@ -73,7 +73,7 @@ lockfile = `} Path to a lockfile used for installing the tool. -Set to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.19.0/src/python/pants/backend/codegen/avro/java/avro-tools.default.lockfile.txt for the default lockfile contents. +Set to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.19.1/src/python/pants/backend/codegen/avro/java/avro-tools.default.lockfile.txt for the default lockfile contents. To use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=java-avro`. diff --git a/versioned_docs/version-2.19/reference/subsystems/junit.mdx b/versioned_docs/version-2.19/reference/subsystems/junit.mdx index f6b691bbe..c4a4f4dcf 100644 --- a/versioned_docs/version-2.19/reference/subsystems/junit.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/junit.mdx @@ -103,7 +103,7 @@ lockfile = `} Path to a lockfile used for installing the tool. -Set to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.19.0/src/python/pants/jvm/test/junit.default.lockfile.txt for the default lockfile contents. +Set to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.19.1/src/python/pants/jvm/test/junit.default.lockfile.txt for the default lockfile contents. To use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=junit`. diff --git a/versioned_docs/version-2.19/reference/subsystems/ktlint.mdx b/versioned_docs/version-2.19/reference/subsystems/ktlint.mdx index 9f8249532..d1ce52529 100644 --- a/versioned_docs/version-2.19/reference/subsystems/ktlint.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/ktlint.mdx @@ -85,7 +85,7 @@ lockfile = `} Path to a lockfile used for installing the tool. -Set to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.19.0/src/python/pants/backend/kotlin/lint/ktlint/ktlint.lock for the default lockfile contents. +Set to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.19.1/src/python/pants/backend/kotlin/lint/ktlint/ktlint.lock for the default lockfile contents. To use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=ktlint`. diff --git a/versioned_docs/version-2.19/reference/subsystems/openapi-generator.mdx b/versioned_docs/version-2.19/reference/subsystems/openapi-generator.mdx index 1ef224267..e4d5859cb 100644 --- a/versioned_docs/version-2.19/reference/subsystems/openapi-generator.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/openapi-generator.mdx @@ -73,7 +73,7 @@ lockfile = `} Path to a lockfile used for installing the tool. -Set to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.19.0/src/python/pants/backend/openapi/subsystems/openapi_generator.default.lockfile.txt for the default lockfile contents. +Set to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.19.1/src/python/pants/backend/openapi/subsystems/openapi_generator.default.lockfile.txt for the default lockfile contents. To use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=openapi-generator`. diff --git a/versioned_docs/version-2.19/reference/subsystems/protobuf-java-grpc.mdx b/versioned_docs/version-2.19/reference/subsystems/protobuf-java-grpc.mdx index f9a2d2d2d..71cb53917 100644 --- a/versioned_docs/version-2.19/reference/subsystems/protobuf-java-grpc.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/protobuf-java-grpc.mdx @@ -73,7 +73,7 @@ lockfile = `} Path to a lockfile used for installing the tool. -Set to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.19.0/src/python/pants/backend/codegen/protobuf/java/grpc-java.default.lockfile.txt for the default lockfile contents. +Set to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.19.1/src/python/pants/backend/codegen/protobuf/java/grpc-java.default.lockfile.txt for the default lockfile contents. To use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=protobuf-java-grpc`. diff --git a/versioned_docs/version-2.19/reference/subsystems/pydocstyle.mdx b/versioned_docs/version-2.19/reference/subsystems/pydocstyle.mdx index 66a17b8f5..51e4b4f1d 100644 --- a/versioned_docs/version-2.19/reference/subsystems/pydocstyle.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/pydocstyle.mdx @@ -79,7 +79,7 @@ config_discovery = `} If true, Pants will include any relevant config files during runs (`setup.cfg`, `tox.ini`, `.pydocstyle`, `.pydocstyle.ini`, `.pydocstylerc`, `.pydocstylerc.ini`, and `pyproject.toml`) searching for the configuration file in this particular order. -Please note that even though `pydocstyle` keeps looking for a configuration file up the directory tree until one is found, Pants will only search for the config files in the repository root (from where you would normally run the `` command). +Please note that even though `pydocstyle` keeps looking for a configuration file up the directory tree until one is found, Pants will only search for the config files in the repository root (from where you would normally run the `pants` command). Use `[pydocstyle].config` instead if your config is in a non-standard location. diff --git a/versioned_docs/version-2.19/reference/subsystems/scalafmt.mdx b/versioned_docs/version-2.19/reference/subsystems/scalafmt.mdx index 8f1a25ed6..c7a239df9 100644 --- a/versioned_docs/version-2.19/reference/subsystems/scalafmt.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/scalafmt.mdx @@ -85,7 +85,7 @@ lockfile = `} Path to a lockfile used for installing the tool. -Set to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.19.0/src/python/pants/backend/scala/lint/scalafmt/scalafmt.default.lockfile.txt for the default lockfile contents. +Set to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.19.1/src/python/pants/backend/scala/lint/scalafmt/scalafmt.default.lockfile.txt for the default lockfile contents. To use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=scalafmt`. diff --git a/versioned_docs/version-2.19/reference/subsystems/scalapb.mdx b/versioned_docs/version-2.19/reference/subsystems/scalapb.mdx index 81c12cf77..2bdc15bc2 100644 --- a/versioned_docs/version-2.19/reference/subsystems/scalapb.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/scalapb.mdx @@ -91,7 +91,7 @@ lockfile = `} Path to a lockfile used for installing the tool. -Set to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.19.0/src/python/pants/backend/codegen/protobuf/scala/scalapbc.default.lockfile.txt for the default lockfile contents. +Set to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.19.1/src/python/pants/backend/codegen/protobuf/scala/scalapbc.default.lockfile.txt for the default lockfile contents. To use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=scalapb`. diff --git a/versioned_docs/version-2.19/reference/subsystems/scalatest.mdx b/versioned_docs/version-2.19/reference/subsystems/scalatest.mdx index 75aa3f96a..438ae34ac 100644 --- a/versioned_docs/version-2.19/reference/subsystems/scalatest.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/scalatest.mdx @@ -105,7 +105,7 @@ lockfile = `} Path to a lockfile used for installing the tool. -Set to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.19.0/src/python/pants/backend/scala/subsystems/scalatest.default.lockfile.txt for the default lockfile contents. +Set to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.19.1/src/python/pants/backend/scala/subsystems/scalatest.default.lockfile.txt for the default lockfile contents. To use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=scalatest`. diff --git a/versioned_docs/version-2.19/reference/subsystems/scrooge.mdx b/versioned_docs/version-2.19/reference/subsystems/scrooge.mdx index 089834086..e7b6ca5b0 100644 --- a/versioned_docs/version-2.19/reference/subsystems/scrooge.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/scrooge.mdx @@ -73,7 +73,7 @@ lockfile = `} Path to a lockfile used for installing the tool. -Set to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.19.0/src/python/pants/backend/codegen/thrift/scrooge/scrooge.default.lockfile.txt for the default lockfile contents. +Set to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.19.1/src/python/pants/backend/codegen/thrift/scrooge/scrooge.default.lockfile.txt for the default lockfile contents. To use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=scrooge`. diff --git a/versioned_docs/version-2.19/reference/targets/jvm_artifact.mdx b/versioned_docs/version-2.19/reference/targets/jvm_artifact.mdx index c2b2c5ba2..c97a7cb4c 100644 --- a/versioned_docs/version-2.19/reference/targets/jvm_artifact.mdx +++ b/versioned_docs/version-2.19/reference/targets/jvm_artifact.mdx @@ -135,7 +135,7 @@ The JVM packages this artifact provides for the purposes of dependency inference For example, the JVM artifact `junit:junit` might provide `["org.junit.**"]`. -Usually you can leave this field off. If unspecified, Pants will fall back to the `[java-infer].third_party_import_mapping`, then to a built in mapping (https://github.com/pantsbuild/pants/blob/release_2.19.0/src/python/pants/jvm/dependency_inference/jvm_artifact_mappings.py), and then finally it will default to the normalized `group` of the artifact. For example, in the absence of any other mapping the artifact `io.confluent:common-config` would default to providing `["io.confluent.**"]`. +Usually you can leave this field off. If unspecified, Pants will fall back to the `[java-infer].third_party_import_mapping`, then to a built in mapping (https://github.com/pantsbuild/pants/blob/release_2.19.1/src/python/pants/jvm/dependency_inference/jvm_artifact_mappings.py), and then finally it will default to the normalized `group` of the artifact. For example, in the absence of any other mapping the artifact `io.confluent:common-config` would default to providing `["io.confluent.**"]`. The package path may be made recursive to match symbols in subpackages by adding `.**` to the end of the package path. For example, specify `["org.junit.**"]` to infer a dependency on the artifact for any file importing a symbol from `org.junit` or its subpackages. diff --git a/versioned_docs/version-2.19/reference/targets/pants_requirements.mdx b/versioned_docs/version-2.19/reference/targets/pants_requirements.mdx index 3de2527e2..500609bc4 100644 --- a/versioned_docs/version-2.19/reference/targets/pants_requirements.mdx +++ b/versioned_docs/version-2.19/reference/targets/pants_requirements.mdx @@ -79,7 +79,7 @@ If true, include `pantsbuild.pants.testutil` to write tests for your plugin. The PEP 440 version specifier version of Pants to target. E.g. `== 2.15.*`, or `>= 2.16.0, < 2.17.0` diff --git a/versioned_docs/version-2.19/reference/targets/python_requirement.mdx b/versioned_docs/version-2.19/reference/targets/python_requirement.mdx index edaa92be9..d996aa919 100644 --- a/versioned_docs/version-2.19/reference/targets/python_requirement.mdx +++ b/versioned_docs/version-2.19/reference/targets/python_requirement.mdx @@ -96,7 +96,7 @@ The modules this requirement provides (used for dependency inference). For example, the requirement `setuptools` provides `["setuptools", "pkg_resources", "easy_install"]`. -Usually you can leave this field off. If unspecified, Pants will first look at the default module mapping (https://github.com/pantsbuild/pants/blob/release_2.19.0/src/python/pants/backend/python/dependency_inference/default_module_mapping.py), and then will default to the normalized project name. For example, the requirement `Django` would default to the module `django`. +Usually you can leave this field off. If unspecified, Pants will first look at the default module mapping (https://github.com/pantsbuild/pants/blob/release_2.19.1/src/python/pants/backend/python/dependency_inference/default_module_mapping.py), and then will default to the normalized project name. For example, the requirement `Django` would default to the module `django`. Mutually exclusive with the `type_stub_modules` field. @@ -141,7 +141,7 @@ The modules this requirement provides if the requirement is a type stub (used fo For example, the requirement `types-requests` provides `["requests"]`. -Usually you can leave this field off. If unspecified, Pants will first look at the default module mapping (https://github.com/pantsbuild/pants/blob/release_2.19.0/src/python/pants/backend/python/dependency_inference/default_module_mapping.py). If not found _and_ the requirement name starts with `types-` or `stubs-`, or ends with `-types` or `-stubs`, will default to that requirement name without the prefix/suffix. For example, `types-requests` would default to `requests`. Otherwise, will be treated like a normal requirement (see the `modules` field). +Usually you can leave this field off. If unspecified, Pants will first look at the default module mapping (https://github.com/pantsbuild/pants/blob/release_2.19.1/src/python/pants/backend/python/dependency_inference/default_module_mapping.py). If not found _and_ the requirement name starts with `types-` or `stubs-`, or ends with `-types` or `-stubs`, will default to that requirement name without the prefix/suffix. For example, `types-requests` would default to `requests`. Otherwise, will be treated like a normal requirement (see the `modules` field). Mutually exclusive with the `modules` field. diff --git a/versioned_docs/version-2.19/reference/targets/scala_artifact.mdx b/versioned_docs/version-2.19/reference/targets/scala_artifact.mdx index 9088df325..f821d16b9 100644 --- a/versioned_docs/version-2.19/reference/targets/scala_artifact.mdx +++ b/versioned_docs/version-2.19/reference/targets/scala_artifact.mdx @@ -151,7 +151,7 @@ The JVM packages this artifact provides for the purposes of dependency inference For example, the JVM artifact `junit:junit` might provide `["org.junit.**"]`. -Usually you can leave this field off. If unspecified, Pants will fall back to the `[java-infer].third_party_import_mapping`, then to a built in mapping (https://github.com/pantsbuild/pants/blob/release_2.19.0/src/python/pants/jvm/dependency_inference/jvm_artifact_mappings.py), and then finally it will default to the normalized `group` of the artifact. For example, in the absence of any other mapping the artifact `io.confluent:common-config` would default to providing `["io.confluent.**"]`. +Usually you can leave this field off. If unspecified, Pants will fall back to the `[java-infer].third_party_import_mapping`, then to a built in mapping (https://github.com/pantsbuild/pants/blob/release_2.19.1/src/python/pants/jvm/dependency_inference/jvm_artifact_mappings.py), and then finally it will default to the normalized `group` of the artifact. For example, in the absence of any other mapping the artifact `io.confluent:common-config` would default to providing `["io.confluent.**"]`. The package path may be made recursive to match symbols in subpackages by adding `.**` to the end of the package path. For example, specify `["org.junit.**"]` to infer a dependency on the artifact for any file importing a symbol from `org.junit` or its subpackages.