Update docs site for version 2.18.3 (#169)

Docs from https://github.com/pantsbuild/pants/releases/tag/release_2.18.3 --------- Co-authored-by: Huon Wilson <[email protected]>
pantsbuild · Mar 7, 2024 · 1d11d4c · 1d11d4c
1 parent ac1d705
commit 1d11d4c
Show file tree

Hide file tree

Showing 22 changed files with 738 additions and 699 deletions.
diff --git a/versioned_docs/version-2.18/docs/python/overview/lockfiles.mdx b/versioned_docs/version-2.18/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.18/docs/shell/run-shell-commands.mdx b/versioned_docs/version-2.18/docs/shell/run-shell-commands.mdx
@@ -39,7 +39,7 @@ The `command` field is passed to `bash -c <command>`. 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.18/docs/terraform/_category_.json b/versioned_docs/version-2.18/docs/terraform/_category_.json
@@ -1,4 +1,4 @@
 {
-  "label": "terraform",
+  "label": "Terraform",
   "position": 11
 }
diff --git a/versioned_docs/version-2.18/docs/using-pants/setting-up-an-ide.mdx b/versioned_docs/version-2.18/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.18/reference/goals/export.mdx b/versioned_docs/version-2.18/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: <span className="color--primary">`pants.core`</span>
 
 Config section: <span className="color--primary">`[export]`</span>

diff --git a/versioned_docs/version-2.18/reference/help-all.json b/versioned_docs/version-2.18/reference/help-all.json
diff --git a/versioned_docs/version-2.18/reference/subsystems/google-java-format.mdx b/versioned_docs/version-2.18/reference/subsystems/google-java-format.mdx
@@ -99,7 +99,7 @@ lockfile = <str>`}
 
 Path to a lockfile used for installing the tool.
 
-Set to the string `<default>` 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.18.2/src/python/pants/backend/java/lint/google_java_format/google_java_format.default.lockfile.txt for the default lockfile contents.
+Set to the string `<default>` 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.18.3/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.18/reference/subsystems/jarjar.mdx b/versioned_docs/version-2.18/reference/subsystems/jarjar.mdx
@@ -100,7 +100,7 @@ lockfile = <str>`}
 
 Path to a lockfile used for installing the tool.
 
-Set to the string `<default>` 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.18.2/src/python/pants/jvm/shading/jarjar.default.lockfile.txt for the default lockfile contents.
+Set to the string `<default>` 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.18.3/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.18/reference/subsystems/java-avro.mdx b/versioned_docs/version-2.18/reference/subsystems/java-avro.mdx
@@ -73,7 +73,7 @@ lockfile = <str>`}
 
 Path to a lockfile used for installing the tool.
 
-Set to the string `<default>` 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.18.2/src/python/pants/backend/codegen/avro/java/avro-tools.default.lockfile.txt for the default lockfile contents.
+Set to the string `<default>` 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.18.3/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.18/reference/subsystems/junit.mdx b/versioned_docs/version-2.18/reference/subsystems/junit.mdx
@@ -103,7 +103,7 @@ lockfile = <str>`}
 
 Path to a lockfile used for installing the tool.
 
-Set to the string `<default>` 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.18.2/src/python/pants/jvm/test/junit.default.lockfile.txt for the default lockfile contents.
+Set to the string `<default>` 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.18.3/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.18/reference/subsystems/ktlint.mdx b/versioned_docs/version-2.18/reference/subsystems/ktlint.mdx
@@ -85,7 +85,7 @@ lockfile = <str>`}
 
 Path to a lockfile used for installing the tool.
 
-Set to the string `<default>` 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.18.2/src/python/pants/backend/kotlin/lint/ktlint/ktlint.lock for the default lockfile contents.
+Set to the string `<default>` 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.18.3/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.18/reference/subsystems/openapi-generator.mdx b/versioned_docs/version-2.18/reference/subsystems/openapi-generator.mdx
@@ -73,7 +73,7 @@ lockfile = <str>`}
 
 Path to a lockfile used for installing the tool.
 
-Set to the string `<default>` 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.18.2/src/python/pants/backend/openapi/subsystems/openapi_generator.default.lockfile.txt for the default lockfile contents.
+Set to the string `<default>` 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.18.3/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.18/reference/subsystems/protobuf-java-grpc.mdx b/versioned_docs/version-2.18/reference/subsystems/protobuf-java-grpc.mdx
@@ -73,7 +73,7 @@ lockfile = <str>`}
 
 Path to a lockfile used for installing the tool.
 
-Set to the string `<default>` 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.18.2/src/python/pants/backend/codegen/protobuf/java/grpc-java.default.lockfile.txt for the default lockfile contents.
+Set to the string `<default>` 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.18.3/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.18/reference/subsystems/pydocstyle.mdx b/versioned_docs/version-2.18/reference/subsystems/pydocstyle.mdx
@@ -79,7 +79,7 @@ config_discovery = <bool>`}
 
 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 `<function bin_name at 0x7f051c5213a0>` 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 `<function bin_name at 0x7f4de8be03a0>` command).
 
 Use `[pydocstyle].config` instead if your config is in a non-standard location.
 

diff --git a/versioned_docs/version-2.18/reference/subsystems/scalafmt.mdx b/versioned_docs/version-2.18/reference/subsystems/scalafmt.mdx
@@ -85,7 +85,7 @@ lockfile = <str>`}
 
 Path to a lockfile used for installing the tool.
 
-Set to the string `<default>` 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.18.2/src/python/pants/backend/scala/lint/scalafmt/scalafmt.default.lockfile.txt for the default lockfile contents.
+Set to the string `<default>` 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.18.3/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.18/reference/subsystems/scalapb.mdx b/versioned_docs/version-2.18/reference/subsystems/scalapb.mdx
@@ -91,7 +91,7 @@ lockfile = <str>`}
 
 Path to a lockfile used for installing the tool.
 
-Set to the string `<default>` 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.18.2/src/python/pants/backend/codegen/protobuf/scala/scalapbc.default.lockfile.txt for the default lockfile contents.
+Set to the string `<default>` 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.18.3/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.18/reference/subsystems/scalatest.mdx b/versioned_docs/version-2.18/reference/subsystems/scalatest.mdx
@@ -105,7 +105,7 @@ lockfile = <str>`}
 
 Path to a lockfile used for installing the tool.
 
-Set to the string `<default>` 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.18.2/src/python/pants/backend/scala/subsystems/scalatest.default.lockfile.txt for the default lockfile contents.
+Set to the string `<default>` 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.18.3/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.18/reference/subsystems/scrooge.mdx b/versioned_docs/version-2.18/reference/subsystems/scrooge.mdx
@@ -73,7 +73,7 @@ lockfile = <str>`}
 
 Path to a lockfile used for installing the tool.
 
-Set to the string `<default>` 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.18.2/src/python/pants/backend/codegen/thrift/scrooge/scrooge.default.lockfile.txt for the default lockfile contents.
+Set to the string `<default>` 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.18.3/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.18/reference/targets/jvm_artifact.mdx b/versioned_docs/version-2.18/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.18.2/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.18.3/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.18/reference/targets/pants_requirements.mdx b/versioned_docs/version-2.18/reference/targets/pants_requirements.mdx
@@ -79,7 +79,7 @@ If true, include `pantsbuild.pants.testutil` to write tests for your plugin.
 
 <Field
     type_repr={`str | None`}
-    default_repr={`'== 2.18.2'`}
+    default_repr={`'== 2.18.3'`}
 >
 
 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.18/reference/targets/python_requirement.mdx b/versioned_docs/version-2.18/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.18.2/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.18.3/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.18.2/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.18.3/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.18/reference/targets/scala_artifact.mdx b/versioned_docs/version-2.18/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.18.2/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.18.3/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.