Merge pull request #11499 from pfmoore/nox_comment

Add a warning comment to the vendoring session in noxfile
pypa · Oct 8, 2022 · 8f381cd · 8f381cd
2 parents 569d0d7 + 08b7a10
commit 8f381cd
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/noxfile.py b/noxfile.py
@@ -172,6 +172,13 @@ def lint(session: nox.Session) -> None:
     session.run("pre-commit", "run", *args)
 
 
+# NOTE: This session will COMMIT upgrades to vendored libraries.
+# You should therefore not run it directly against `main`. If you
+# do (assuming you started with a clean main), you can run:
+#
+# git checkout -b vendoring-updates
+# git checkout main
+# git reset --hard origin/main
 @nox.session
 def vendoring(session: nox.Session) -> None:
     session.install("vendoring~=1.2.0")