Skip to content

Commit 46506ec

Browse files
WorkerPantshuonw
andauthored
Update release notes links in Plugin Upgrade Guide docs after movement (Cherry-pick of #20936) (#20941)
This makes three changes to the releases notes links in the "Plugin Upgrade Guide" docs: - adjust the path for the movement in #20847 - fix `.rst` -> `.md` file extension for 2.0.x and 2.1.x - fix `master` -> `main` branch name for 2.0.x and 2.1.x Co-authored-by: Huon Wilson <[email protected]>
1 parent c7e4e0d commit 46506ec

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

docs/docs/writing-plugins/common-plugin-tasks/plugin-upgrade-guide.mdx

+15-15
Original file line numberDiff line numberDiff line change
@@ -309,7 +309,7 @@ The `convert_dir_literal_to_address_literal` keyword argument for `RawSpecs.crea
309309

310310
## 2.14
311311

312-
See [https://github.com/pantsbuild/pants/blob/main/src/python/pants/notes/2.14.x.md](https://github.com/pantsbuild/pants/blob/main/src/python/pants/notes/2.14.x.md) for the changelog.
312+
See [https://github.com/pantsbuild/pants/blob/main/docs/notes/2.14.x.md](https://github.com/pantsbuild/pants/blob/main/docs/notes/2.14.x.md) for the changelog.
313313

314314
### Removed second type parameter from `Get`
315315

@@ -365,7 +365,7 @@ The functionality is the same, but can have better performance because we don't
365365

366366
## 2.13
367367

368-
See [https://github.com/pantsbuild/pants/blob/main/src/python/pants/notes/2.13.x.md](https://github.com/pantsbuild/pants/blob/main/src/python/pants/notes/2.13.x.md) for the changelog.
368+
See [https://github.com/pantsbuild/pants/blob/main/docs/notes/2.13.x.md](https://github.com/pantsbuild/pants/blob/main/docs/notes/2.13.x.md) for the changelog.
369369

370370
### `AddressInput` and `UnparsedAddressInputs` require `description_of_origin`
371371

@@ -448,7 +448,7 @@ You must now use a long option name when [defining options](../the-rules-api/opt
448448

449449
## 2.12
450450

451-
See [https://github.com/pantsbuild/pants/blob/main/src/python/pants/notes/2.12.x.md](https://github.com/pantsbuild/pants/blob/main/src/python/pants/notes/2.12.x.md) for the changelog.
451+
See [https://github.com/pantsbuild/pants/blob/main/docs/notes/2.12.x.md](https://github.com/pantsbuild/pants/blob/main/docs/notes/2.12.x.md) for the changelog.
452452

453453
### Unified formatters
454454

@@ -458,7 +458,7 @@ See [Add a formatter](./add-a-formatter.mdx) for more information.
458458

459459
## 2.11
460460

461-
See [https://github.com/pantsbuild/pants/blob/main/src/python/pants/notes/2.11.x.md](https://github.com/pantsbuild/pants/blob/main/src/python/pants/notes/2.11.x.md) for the changelog.
461+
See [https://github.com/pantsbuild/pants/blob/main/docs/notes/2.11.x.md](https://github.com/pantsbuild/pants/blob/main/docs/notes/2.11.x.md) for the changelog.
462462

463463
### Deprecated `Subsystem.register_options()`
464464

@@ -516,7 +516,7 @@ See [https://github.com/pantsbuild/pants/pull/14313](https://github.com/pantsbui
516516

517517
## 2.10
518518

519-
See [https://github.com/pantsbuild/pants/blob/main/src/python/pants/notes/2.10.x.md](https://github.com/pantsbuild/pants/blob/main/src/python/pants/notes/2.10.x.md) for the changelog.
519+
See [https://github.com/pantsbuild/pants/blob/main/docs/notes/2.10.x.md](https://github.com/pantsbuild/pants/blob/main/docs/notes/2.10.x.md) for the changelog.
520520

521521
### Rename `LintRequest` to `LintTargetsRequest`
522522

@@ -580,15 +580,15 @@ This type was used to determine the owners of a Python module. The new name make
580580

581581
## 2.9
582582

583-
See [https://github.com/pantsbuild/pants/blob/main/src/python/pants/notes/2.9.x.md](https://github.com/pantsbuild/pants/blob/main/src/python/pants/notes/2.9.x.md) for the changelog.
583+
See [https://github.com/pantsbuild/pants/blob/main/docs/notes/2.9.x.md](https://github.com/pantsbuild/pants/blob/main/docs/notes/2.9.x.md) for the changelog.
584584

585585
### Deprecated `RuleRunner.create_files()`, `.create_file()` and `.add_to_build_file()`
586586

587587
Instead, for your `RuleRunner` tests, use `.write_files()`. See [https://github.com/pantsbuild/pants/pull/13817](https://github.com/pantsbuild/pants/pull/13817) for some examples.
588588

589589
## 2.8
590590

591-
See [https://github.com/pantsbuild/pants/blob/main/src/python/pants/notes/2.8.x.md](https://github.com/pantsbuild/pants/blob/main/src/python/pants/notes/2.8.x.md) for the changelog.
591+
See [https://github.com/pantsbuild/pants/blob/main/docs/notes/2.8.x.md](https://github.com/pantsbuild/pants/blob/main/docs/notes/2.8.x.md) for the changelog.
592592

593593
### Target modeling changes
594594

@@ -618,7 +618,7 @@ The method `OutputPathField.value_or_default()` no longer takes `Address` as an
618618

619619
## 2.7
620620

621-
See [https://github.com/pantsbuild/pants/blob/main/src/python/pants/notes/2.7.x.md](https://github.com/pantsbuild/pants/blob/main/src/python/pants/notes/2.7.x.md) for the changelog.
621+
See [https://github.com/pantsbuild/pants/blob/main/docs/notes/2.7.x.md](https://github.com/pantsbuild/pants/blob/main/docs/notes/2.7.x.md) for the changelog.
622622

623623
### Type hints work properly
624624

@@ -630,7 +630,7 @@ For example, use `my-subsystem` instead of `my_subsystem`. This is to avoid ambi
630630

631631
## 2.6
632632

633-
See [https://github.com/pantsbuild/pants/blob/main/src/python/pants/notes/2.6.x.md](https://github.com/pantsbuild/pants/blob/main/src/python/pants/notes/2.6.x.md) for the changelog.
633+
See [https://github.com/pantsbuild/pants/blob/main/docs/notes/2.6.x.md](https://github.com/pantsbuild/pants/blob/main/docs/notes/2.6.x.md) for the changelog.
634634

635635
### `ProcessCacheScope`
636636

@@ -644,7 +644,7 @@ Now called `InterpreterConstraints` and defined in `pants.backend.python.util_ru
644644

645645
## 2.5
646646

647-
See [https://github.com/pantsbuild/pants/blob/main/src/python/pants/notes/2.5.x.md](https://github.com/pantsbuild/pants/blob/main/src/python/pants/notes/2.5.x.md) for the changelog.
647+
See [https://github.com/pantsbuild/pants/blob/main/docs/notes/2.5.x.md](https://github.com/pantsbuild/pants/blob/main/docs/notes/2.5.x.md) for the changelog.
648648

649649
### `TriBoolField`
650650

@@ -658,7 +658,7 @@ This is a more declarative way to set up files than the older API of `RuleRunner
658658

659659
## 2.4
660660

661-
See [https://github.com/pantsbuild/pants/blob/main/src/python/pants/notes/2.4.x.md](https://github.com/pantsbuild/pants/blob/main/src/python/pants/notes/2.4.x.md) for the changelog.
661+
See [https://github.com/pantsbuild/pants/blob/main/docs/notes/2.4.x.md](https://github.com/pantsbuild/pants/blob/main/docs/notes/2.4.x.md) for the changelog.
662662

663663
### `PexRequest` changes how entry point is set
664664

@@ -674,11 +674,11 @@ For `RuleRunner` tests, you must now either set `env` or the new `env_inherit` a
674674

675675
## 2.3
676676

677-
There were no substantial changes to the Plugin API in 2.3. See [https://github.com/pantsbuild/pants/blob/main/src/python/pants/notes/2.3.x.md](https://github.com/pantsbuild/pants/blob/main/src/python/pants/notes/2.3.x.md) for the changelog.
677+
There were no substantial changes to the Plugin API in 2.3. See [https://github.com/pantsbuild/pants/blob/main/docs/notes/2.3.x.md](https://github.com/pantsbuild/pants/blob/main/docs/notes/2.3.x.md) for the changelog.
678678

679679
## 2.2
680680

681-
See [https://github.com/pantsbuild/pants/blob/main/src/python/pants/notes/2.2.x.md](https://github.com/pantsbuild/pants/blob/main/src/python/pants/notes/2.2.x.md) for the changelog.
681+
See [https://github.com/pantsbuild/pants/blob/main/docs/notes/2.2.x.md](https://github.com/pantsbuild/pants/blob/main/docs/notes/2.2.x.md) for the changelog.
682682

683683
### `PrimitiveField` and `AsyncField` are removed (2.2.0.dev0)
684684

@@ -710,15 +710,15 @@ Pants will now properly wrap strings and preserve newlines. You may want to run
710710

711711
## 2.1
712712

713-
See [https://github.com/pantsbuild/pants/blob/master/src/python/pants/notes/2.1.x.rst](https://github.com/pantsbuild/pants/blob/master/src/python/pants/notes/2.1.x.rst) for the changelog.
713+
See [https://github.com/pantsbuild/pants/blob/main/docs/notes/2.1.x.md](https://github.com/pantsbuild/pants/blob/main/docs/notes/2.1.x.md) for the changelog.
714714

715715
### `SourcesSnapshot` is now `SpecsSnapshot` (2.1.0rc0)
716716

717717
The type was renamed for clarity. Still import it from `pants.engine.fs`.
718718

719719
## 2.0
720720

721-
See [https://github.com/pantsbuild/pants/blob/master/src/python/pants/notes/2.0.x.rst](https://github.com/pantsbuild/pants/blob/master/src/python/pants/notes/2.0.x.rst) for the changelog.
721+
See [https://github.com/pantsbuild/pants/blob/main/docs/notes/2.0.x.md](https://github.com/pantsbuild/pants/blob/main/docs/notes/2.0.x.md) for the changelog.
722722

723723
### Use `TransitiveTargetsRequest` as input for resolving `TransitiveTargets` (2.0.0rc0)
724724

0 commit comments

Comments
 (0)