Move release notes to docs/notes, don't do wheel builds when changed (#…

…20847) As far as I can tell the release notes (formerly `src/python/pants/notes`) are no longer included in wheel builds, so they can be considered more "normal" documentation. This moves them, and stops the classify-changes script from flagging them as a `release`-level change; they'll now just be `docs`. The pantsbuild.org sync_docs workflow copies the `docs/docs` directory, so won't be automatically including these... but maybe pantsbuild/pantsbuild.org#184 will change this (that PR needs changes, after this).
pantsbuild · Apr 27, 2024 · 2a72e0f · 2a72e0f
1 parent 164f322
commit 2a72e0f
Show file tree

Hide file tree

Showing 58 changed files with 6 additions and 8 deletions.
diff --git a/build-support/bin/classify_changed_files.py b/build-support/bin/classify_changed_files.py
@@ -30,12 +30,10 @@ class Affected(enum.Enum):
     "build-support/bin/rust/*",
 ]
 _release_globs = [
-    # Any changes to these files should trigger wheel building. Notes too, as they are included in
-    # the wheel.
+    # Any changes to these files should trigger wheel building.
     "pants.toml",
     "src/python/pants/VERSION",
     "src/python/pants/init/BUILD",
-    "src/python/pants/notes/*",
     "src/python/pants_release/release.py",
 ]
 _ci_config_globs = [

diff --git a/build-support/bin/classify_changed_files_test.py b/build-support/bin/classify_changed_files_test.py
@@ -14,8 +14,8 @@
             {Affected.docs},
         ],
         [
-            ["src/python/pants/notes/2.16.x.md"],
-            {Affected.docs, Affected.release},
+            ["docs/notes/2.16.x.md"],
+            {Affected.docs},
         ],
         [["src/rust/engine/path/to/file.rs"], {Affected.rust}],
         [["src/python/pants/VERSION"], {Affected.release}],

diff --git a/docs/README.md b/docs/README.md
@@ -2,4 +2,4 @@
 
 This directory holds our handwritten documentation.
 
-During a release, the contents of this directory is synced with our website repo (https://github.com/pantsbuild/pantsbuild.org) to be deployed.
+During a release, the contents of the `docs/` subdirectory is synced with our website repo (https://github.com/pantsbuild/pantsbuild.org) to be deployed.
diff --git a/docs/docs/contributions/releases/release-process.mdx b/docs/docs/contributions/releases/release-process.mdx
@@ -70,7 +70,7 @@ The release commit is the commit that bumps the VERSION string. For `dev`/`a0` r
 
 If this is the first dev release in a new series:
 
-1. Create a new file in ` src/python/pants/notes`, e.g. create `src/python/pants/notes/2.9.x.md`.
+1. Create a new file in `docs/notes`, e.g. create `docs/notes/2.9.x.md`.
    1. Copy the title and template over from the prior release, e.g. `2.8.x.md`.
 
 ### Bump the VERSION

diff --git a/docs/docs/using-pants/restricted-internet-access.mdx b/docs/docs/using-pants/restricted-internet-access.mdx
@@ -101,7 +101,7 @@ url_template = "https://my.custom.host/bin/protoc/{version}/{platform}/protoc.zi
 
 For simplicity, we used the original value for `url_platform_mapping`, meaning that we set up our hosted URL to store the macOS x86 binary at `.../osx-x86_64/protoc.zip`, for example. You can override the option `url_platform_mapping` if you want to use different values.
 
-Occasionally, new Pants releases will upgrade to new versions of these binaries, which will be mentioned in the "User API Changes" part of the changelog [https://github.com/pantsbuild/pants/tree/master/src/python/pants/notes](https://github.com/pantsbuild/pants/tree/master/src/python/pants/notes). When upgrading to these new Pants releases, you should download the new artifact and upload a copy to your host.
+Occasionally, new Pants releases will upgrade to new versions of these binaries, which will be mentioned in the "User API Changes" part of the changelog [https://github.com/pantsbuild/pants/tree/main/docs/notes](https://github.com/pantsbuild/pants/tree/main/docs/notes). When upgrading to these new Pants releases, you should download the new artifact and upload a copy to your host.
 
 :::note Asking for help
 It's possible that Pants does not yet have all the mechanisms it'll need to work with your organization's specific networking setup, which we'd love to fix.

diff --git a/src/python/pants/notes/1.0.x.rst → docs/notes/1.0.x.rst b/src/python/pants/notes/1.0.x.rst → docs/notes/1.0.x.rst
diff --git a/src/python/pants/notes/1.1.x.rst → docs/notes/1.1.x.rst b/src/python/pants/notes/1.1.x.rst → docs/notes/1.1.x.rst
diff --git a/src/python/pants/notes/1.10.x.rst → docs/notes/1.10.x.rst b/src/python/pants/notes/1.10.x.rst → docs/notes/1.10.x.rst
diff --git a/src/python/pants/notes/1.11.x.rst → docs/notes/1.11.x.rst b/src/python/pants/notes/1.11.x.rst → docs/notes/1.11.x.rst
diff --git a/src/python/pants/notes/1.12.x.rst → docs/notes/1.12.x.rst b/src/python/pants/notes/1.12.x.rst → docs/notes/1.12.x.rst
diff --git a/src/python/pants/notes/1.13.x.rst → docs/notes/1.13.x.rst b/src/python/pants/notes/1.13.x.rst → docs/notes/1.13.x.rst
diff --git a/src/python/pants/notes/1.14.x.rst → docs/notes/1.14.x.rst b/src/python/pants/notes/1.14.x.rst → docs/notes/1.14.x.rst
diff --git a/src/python/pants/notes/1.15.x.rst → docs/notes/1.15.x.rst b/src/python/pants/notes/1.15.x.rst → docs/notes/1.15.x.rst
diff --git a/src/python/pants/notes/1.16.x.rst → docs/notes/1.16.x.rst b/src/python/pants/notes/1.16.x.rst → docs/notes/1.16.x.rst
diff --git a/src/python/pants/notes/1.17.x.rst → docs/notes/1.17.x.rst b/src/python/pants/notes/1.17.x.rst → docs/notes/1.17.x.rst
diff --git a/src/python/pants/notes/1.18.x.rst → docs/notes/1.18.x.rst b/src/python/pants/notes/1.18.x.rst → docs/notes/1.18.x.rst
diff --git a/src/python/pants/notes/1.19.x.rst → docs/notes/1.19.x.rst b/src/python/pants/notes/1.19.x.rst → docs/notes/1.19.x.rst
diff --git a/src/python/pants/notes/1.2.x.rst → docs/notes/1.2.x.rst b/src/python/pants/notes/1.2.x.rst → docs/notes/1.2.x.rst
diff --git a/src/python/pants/notes/1.20.x.rst → docs/notes/1.20.x.rst b/src/python/pants/notes/1.20.x.rst → docs/notes/1.20.x.rst
diff --git a/src/python/pants/notes/1.21.x.rst → docs/notes/1.21.x.rst b/src/python/pants/notes/1.21.x.rst → docs/notes/1.21.x.rst
diff --git a/src/python/pants/notes/1.22.x.rst → docs/notes/1.22.x.rst b/src/python/pants/notes/1.22.x.rst → docs/notes/1.22.x.rst
diff --git a/src/python/pants/notes/1.23.x.rst → docs/notes/1.23.x.rst b/src/python/pants/notes/1.23.x.rst → docs/notes/1.23.x.rst
diff --git a/src/python/pants/notes/1.24.x.rst → docs/notes/1.24.x.rst b/src/python/pants/notes/1.24.x.rst → docs/notes/1.24.x.rst
diff --git a/src/python/pants/notes/1.25.x.rst → docs/notes/1.25.x.rst b/src/python/pants/notes/1.25.x.rst → docs/notes/1.25.x.rst
diff --git a/src/python/pants/notes/1.26.x.rst → docs/notes/1.26.x.rst b/src/python/pants/notes/1.26.x.rst → docs/notes/1.26.x.rst
diff --git a/src/python/pants/notes/1.27.x.rst → docs/notes/1.27.x.rst b/src/python/pants/notes/1.27.x.rst → docs/notes/1.27.x.rst
diff --git a/src/python/pants/notes/1.28.x.rst → docs/notes/1.28.x.rst b/src/python/pants/notes/1.28.x.rst → docs/notes/1.28.x.rst
diff --git a/src/python/pants/notes/1.29.x.rst → docs/notes/1.29.x.rst b/src/python/pants/notes/1.29.x.rst → docs/notes/1.29.x.rst
diff --git a/src/python/pants/notes/1.3.x.rst → docs/notes/1.3.x.rst b/src/python/pants/notes/1.3.x.rst → docs/notes/1.3.x.rst
diff --git a/src/python/pants/notes/1.30.x.rst → docs/notes/1.30.x.rst b/src/python/pants/notes/1.30.x.rst → docs/notes/1.30.x.rst
diff --git a/src/python/pants/notes/1.4.x.rst → docs/notes/1.4.x.rst b/src/python/pants/notes/1.4.x.rst → docs/notes/1.4.x.rst
diff --git a/src/python/pants/notes/1.5.x.rst → docs/notes/1.5.x.rst b/src/python/pants/notes/1.5.x.rst → docs/notes/1.5.x.rst
diff --git a/src/python/pants/notes/1.6.x.rst → docs/notes/1.6.x.rst b/src/python/pants/notes/1.6.x.rst → docs/notes/1.6.x.rst
diff --git a/src/python/pants/notes/1.7.x.rst → docs/notes/1.7.x.rst b/src/python/pants/notes/1.7.x.rst → docs/notes/1.7.x.rst
diff --git a/src/python/pants/notes/1.8.x.rst → docs/notes/1.8.x.rst b/src/python/pants/notes/1.8.x.rst → docs/notes/1.8.x.rst
diff --git a/src/python/pants/notes/1.9.x.rst → docs/notes/1.9.x.rst b/src/python/pants/notes/1.9.x.rst → docs/notes/1.9.x.rst
diff --git a/src/python/pants/notes/2.0.x.md → docs/notes/2.0.x.md b/src/python/pants/notes/2.0.x.md → docs/notes/2.0.x.md
diff --git a/src/python/pants/notes/2.1.x.md → docs/notes/2.1.x.md b/src/python/pants/notes/2.1.x.md → docs/notes/2.1.x.md
diff --git a/src/python/pants/notes/2.10.x.md → docs/notes/2.10.x.md b/src/python/pants/notes/2.10.x.md → docs/notes/2.10.x.md
diff --git a/src/python/pants/notes/2.11.x.md → docs/notes/2.11.x.md b/src/python/pants/notes/2.11.x.md → docs/notes/2.11.x.md
diff --git a/src/python/pants/notes/2.12.x.md → docs/notes/2.12.x.md b/src/python/pants/notes/2.12.x.md → docs/notes/2.12.x.md
diff --git a/src/python/pants/notes/2.13.x.md → docs/notes/2.13.x.md b/src/python/pants/notes/2.13.x.md → docs/notes/2.13.x.md
diff --git a/src/python/pants/notes/2.14.x.md → docs/notes/2.14.x.md b/src/python/pants/notes/2.14.x.md → docs/notes/2.14.x.md
diff --git a/src/python/pants/notes/2.15.x.md → docs/notes/2.15.x.md b/src/python/pants/notes/2.15.x.md → docs/notes/2.15.x.md
diff --git a/src/python/pants/notes/2.16.x.md → docs/notes/2.16.x.md b/src/python/pants/notes/2.16.x.md → docs/notes/2.16.x.md
diff --git a/src/python/pants/notes/2.17.x.md → docs/notes/2.17.x.md b/src/python/pants/notes/2.17.x.md → docs/notes/2.17.x.md
diff --git a/src/python/pants/notes/2.18.x.md → docs/notes/2.18.x.md b/src/python/pants/notes/2.18.x.md → docs/notes/2.18.x.md
diff --git a/src/python/pants/notes/2.19.x.md → docs/notes/2.19.x.md b/src/python/pants/notes/2.19.x.md → docs/notes/2.19.x.md
diff --git a/src/python/pants/notes/2.2.x.md → docs/notes/2.2.x.md b/src/python/pants/notes/2.2.x.md → docs/notes/2.2.x.md
diff --git a/src/python/pants/notes/2.20.x.md → docs/notes/2.20.x.md b/src/python/pants/notes/2.20.x.md → docs/notes/2.20.x.md
diff --git a/src/python/pants/notes/2.3.x.md → docs/notes/2.3.x.md b/src/python/pants/notes/2.3.x.md → docs/notes/2.3.x.md
diff --git a/src/python/pants/notes/2.4.x.md → docs/notes/2.4.x.md b/src/python/pants/notes/2.4.x.md → docs/notes/2.4.x.md
diff --git a/src/python/pants/notes/2.5.x.md → docs/notes/2.5.x.md b/src/python/pants/notes/2.5.x.md → docs/notes/2.5.x.md
diff --git a/src/python/pants/notes/2.6.x.md → docs/notes/2.6.x.md b/src/python/pants/notes/2.6.x.md → docs/notes/2.6.x.md
diff --git a/src/python/pants/notes/2.7.x.md → docs/notes/2.7.x.md b/src/python/pants/notes/2.7.x.md → docs/notes/2.7.x.md
diff --git a/src/python/pants/notes/2.8.x.md → docs/notes/2.8.x.md b/src/python/pants/notes/2.8.x.md → docs/notes/2.8.x.md
diff --git a/src/python/pants/notes/2.9.x.md → docs/notes/2.9.x.md b/src/python/pants/notes/2.9.x.md → docs/notes/2.9.x.md
diff --git a/src/python/pants/notes/master.rst → docs/notes/master.rst b/src/python/pants/notes/master.rst → docs/notes/master.rst
Original file line number	Diff line number	Diff line change
Expand Up		@@ -2,4 +2,4 @@

		This directory holds our handwritten documentation.

		During a release, the contents of this directory is synced with our website repo (https://github.com/pantsbuild/pantsbuild.org) to be deployed.
		During a release, the contents of the `docs/` subdirectory is synced with our website repo (https://github.com/pantsbuild/pantsbuild.org) to be deployed.