Add manual update notes to update.sh

JorelAli · Jul 22, 2024 · cd08812 · cd08812
1 parent bd87a7c
commit cd08812
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 8 deletions.
diff --git a/examples/bukkit/automated-tests-shaded/README.md b/examples/bukkit/automated-tests-shaded/README.md
@@ -1,8 +1,6 @@
 # Automated tests (shaded)
 
-A simple example showcasing testing CommandAPI commands with [MockBukkit](https://github.com/MockBukkit/MockBukkit). For more information on the utility provided by the CommandAPI's testing framework, check the documentation [here](TODO).
-
-[//]: # (TODO: Write documentation and add link here)
+A simple example showcasing testing CommandAPI commands with [MockBukkit](https://github.com/MockBukkit/MockBukkit). For more information on the utility provided by the CommandAPI's testing framework, check the documentation [here](https://commandapi-live-docs.jorel.dev/test_intro.html).
 
 Key points:
 

diff --git a/examples/bukkit/automated-tests/README.md b/examples/bukkit/automated-tests/README.md
@@ -1,8 +1,6 @@
 # Automated tests (unshaded)
 
-A simple example showcasing testing CommandAPI commands with [MockBukkit](https://github.com/MockBukkit/MockBukkit). For more information on the utility provided by the CommandAPI's testing framework, check the documentation [here](TODO).
-
-[//]: # (TODO: Write documentation and add link here)
+A simple example showcasing testing CommandAPI commands with [MockBukkit](https://github.com/MockBukkit/MockBukkit). For more information on the utility provided by the CommandAPI's testing framework, check the documentation [here](https://commandapi-live-docs.jorel.dev/test_intro.html).
 
 Key points:
 

diff --git a/update.sh b/update.sh
@@ -72,8 +72,6 @@ sed -i "s/<version>$oldVer<\/version>/<version>$newVer<\/version>/" examples/buk
 # Velocity #
 ############
 
-# Note to self: velocity_intro.md in the documentation needs pointing to a SNAPSHOT version (so do that manually)
-
 sed -i "s/<version>$oldVer<\/version>/<version>$newVer<\/version>/" examples/velocity/maven/README.md
 sed -i "s/<version>$oldVer<\/version>/<version>$newVer<\/version>/" examples/velocity/maven/pom.xml
 
@@ -122,3 +120,12 @@ mvn versions:commit -P Platform.Bukkit
 
 mvn versions:set -DnewVersion=$newVer -P Platform.Velocity
 mvn versions:commit -P Platform.Velocity
+
+#######################
+# Manual update notes #
+#######################
+
+echo "IMPORTANT: Manual update notes"
+echo "  ./docssrc/src/velocity_intro.html#adding-the-dependency: \`commandapi-velocity-shade\` dependencies should point to the latest SNAPSHOT version"
+echo "  ./examples/bukkit/automated-tests/README.md: link to \`test_intro.html\` should point to the latest documentation version"
+echo "  ./examples/bukkit/automated-tests-shaded/README.md: link to \`test_intro.html\` should point to the latest documentation version"