chore: cleaning up changelog and release (#24)

.github/workflows/publish.yaml

@@ -10,6 +10,27 @@ on:
 jobs:
   test:
     uses: ./.github/workflows/main.yaml
+
+  create-release:
+    runs-on: ubuntu-latest
+    needs: [publish-maven-central, publish-github-packages]
+    permissions:
+      contents: write
+      packages: write # publish a new github release
+    steps:
+      - uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6
+        with:
+          fetch-depth: 0
+
+      - name: Create Release
+        uses: Roang-zero1/github-create-release-action@57eb9bdce7a964e48788b9e78b5ac766cb684803 # v3.0.1
+        with:
+          version_regex: ^v[[:digit:]]+\.[[:digit:]]+\.[[:digit:]]+
+          changelog_file: CHANGELOG.md
+          create_draft: true
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
   publish:
     needs: test
     runs-on: ubuntu-latest

docs/RELEASING.md

@@ -0,0 +1,17 @@
+# Release Process
+
+## Bump version number
+
+- Update the `version` number in `build.gradle.kts`
+- Update the `pluginVersion` number in `gradle.properties`
+
+## Update the CHANGELOG
+
+You will need to;
+- update the [CHANGELOG.md](../CHANGELOG.md)
+- update the "change-notes" section of the [plugin.xml](../src/main/resources/META-INF/plugin.xml)
+    - This will appear in the "What's new?" section of the plugin page
+
+## When ready, push a new tag
+
+`git tag -a -s v[0-9]+.[0-9]+.[0-9]+`