chore: add RELEASING notes for two shadowed projects.

autonomousapps · Jan 17, 2024 · 8d373f4 · 8d373f4
1 parent e8407c2
commit 8d373f4
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 0 deletions.
diff --git a/shadowed/antlr/RELEASING.md b/shadowed/antlr/RELEASING.md
@@ -0,0 +1,12 @@
+Release procedure for antlr
+
+1. Update CHANGELOG
+1. Update README if needed
+1. `git commit -am "Prepare for antlr release x."`
+1. Verify shadow jar. Run `./gradlew :antlr:shadowJar`. Manually inspect contents.
+1. Publish: `./gradlew :antlr:publishToMavenCentral`
+1. `git tag -a antlr-x -m "antlr version x."`
+1. `git push && git push --tags`
+1. (Optional) Follow instructions in console output to release from Maven Central's staging repo.
+   This step is now automated via the `:promote` task, and should only be necessary if that task
+   fails.
diff --git a/shadowed/asm-relocated/RELEASING.md b/shadowed/asm-relocated/RELEASING.md
@@ -0,0 +1,12 @@
+Release procedure for asm-relocated
+
+1. Update CHANGELOG
+1. Update README if needed
+1. `git commit -am "Prepare for asm-relocated release x."`
+1. Verify shadow jar. Run `./gradlew :asm-relocated:shadowJar`. Manually inspect contents.
+1. Publish: `./gradlew :asm-relocated:publishToMavenCentral`
+1. `git tag -a asm-relocated-x -m "asm-relocated version x."`
+1. `git push && git push --tags`
+1. (Optional) Follow instructions in console output to release from Maven Central's staging repo.
+   This step is now automated via the `:promote` task, and should only be necessary if that task
+   fails.