Merge pull request #267 from m1sk9/update/development-and-websitev1.3.0

docs: Move release notes onto the documentation site and correct the docs against the implementation

3 files changed, 15 insertions, 79 deletions

diff --git a/.github/workflows/release-paper.yaml b/.github/workflows/release-paper.yaml
index 9459ed6..3718163 100644
--- a/.github/workflows/release-paper.yaml
+++ b/.github/workflows/release-paper.yaml
@@ -94,35 +94,13 @@ jobs:
           VERSION=${{ needs.validate.outputs.version }}
           JAR_NAME=${{ needs.validate.outputs.jar_name }}
 
-          cat > /tmp/release-notes.md <<EOF
-          LunaticChat Paper/Folia v${VERSION} has been released.
-
-          ## Download
-
-          - [GitHub](https://github.com/m1sk9/LunaticChat/releases/tag/${TAG_NAME})
-          - [Modrinth (Paper/Folia)](https://modrinth.com/plugin/lunaticchat/version/${VERSION})
-
-          ## What's new
-
-          ### Highlights
-
-          ### New Features
-
-          ### Improvements
-
-          ### Changes
-
-          ### Bug Fixes
-
-          ### Notes
-
-          EOF
-
+          # The notes point at the changelog on the documentation site rather than
+          # repeating it here, so the release notes live in exactly one place.
           gh release create "$TAG_NAME" \
             "platform-paper/build/libs/$JAR_NAME" \
             --title "v${VERSION} (Paper/Folia)" \
             --draft \
-            --notes-file /tmp/release-notes.md
+            --notes "Release notes: [Paper/Folia v${VERSION}](https://lc.m1sk9.dev/changelog/paper/v${VERSION})"
 
       - name: Publish to Modrinth (Paper/Folia)
         uses: cloudnode-pro/modrinth-publish@8dc596b20b94959bf244180235d90729d05a674f # v2
@@ -133,7 +111,7 @@ jobs:
           version: ${{ needs.validate.outputs.version }}
           channel: ${{ env.MODRINTH_CHANNEL }}
           changelog: |-
-            Please refer to the [GitHub release](https://github.com/m1sk9/LunaticChat/releases/tag/paper/v${{ needs.validate.outputs.version }}) for update details.
+            Please refer to the [release notes](https://lc.m1sk9.dev/changelog/paper/v${{ needs.validate.outputs.version }}) for update details.
           loaders: |-
             paper
             folia
diff --git a/.github/workflows/release-velocity.yaml b/.github/workflows/release-velocity.yaml
index e71eef9..561e7ee 100644
--- a/.github/workflows/release-velocity.yaml
+++ b/.github/workflows/release-velocity.yaml
@@ -96,35 +96,13 @@ jobs:
           VERSION=${{ needs.validate.outputs.version }}
           JAR_NAME=${{ needs.validate.outputs.jar_name }}
 
-          cat > /tmp/release-notes.md <<EOF
-          LunaticChat Velocity v${VERSION} has been released.
-
-          ## Download
-
-          - [GitHub](https://github.com/m1sk9/LunaticChat/releases/tag/${TAG_NAME})
-          - [Modrinth (Velocity)](https://modrinth.com/plugin/lunaticchat/version/${VERSION}-velocity)
-
-          ## What's new
-
-          ### Highlights
-
-          ### New Features
-
-          ### Improvements
-
-          ### Changes
-
-          ### Bug Fixes
-
-          ### Notes
-
-          EOF
-
+          # The notes point at the changelog on the documentation site rather than
+          # repeating it here, so the release notes live in exactly one place.
           gh release create "$TAG_NAME" \
             "platform-velocity/build/libs/$JAR_NAME" \
             --title "v${VERSION} (Velocity)" \
             --draft \
-            --notes-file /tmp/release-notes.md
+            --notes "Release notes: [Velocity v${VERSION}](https://lc.m1sk9.dev/changelog/velocity/v${VERSION})"
 
       - name: Publish to Modrinth (Velocity)
         uses: cloudnode-pro/modrinth-publish@8dc596b20b94959bf244180235d90729d05a674f # v2
@@ -135,7 +113,7 @@ jobs:
           version: ${{ needs.validate.outputs.version }}-velocity
           channel: ${{ env.MODRINTH_CHANNEL }}
           changelog: |-
-            Please refer to the [GitHub release](https://github.com/m1sk9/LunaticChat/releases/tag/velocity/v${{ needs.validate.outputs.version }}) for update details.
+            Please refer to the [release notes](https://lc.m1sk9.dev/changelog/velocity/v${{ needs.validate.outputs.version }}) for update details.
           loaders: velocity
           game-versions: ${{ env.MODRINTH_VELOCITY_GAME_VERSIONS }}
           files: platform-velocity/build/libs/${{ needs.validate.outputs.jar_name }}
diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml
index 48be8f8..c139272 100644
--- a/.github/workflows/release.yaml
+++ b/.github/workflows/release.yaml
@@ -100,33 +100,13 @@ jobs:
           PAPER_JAR_NAME=${{ needs.validate.outputs.paper_jar_name }}
           VELOCITY_JAR_NAME=${{ needs.validate.outputs.velocity_jar_name }}
 
+          # The notes point at the changelog on the documentation site rather than
+          # repeating it here, so the release notes live in exactly one place.
           cat > /tmp/release-notes.md <<EOF
-          LunaticChat ${TAG_NAME} has been released.
-
-          | Platform | Version |
-          |----------|---------|
-          | Paper/Folia | ${PAPER_VERSION} |
-          | Velocity | ${VELOCITY_VERSION} |
-
-          ## Download
-
-          - [GitHub](https://github.com/m1sk9/LunaticChat/releases/tag/${TAG_NAME})
-          - Modrinth: [Paper/Folia](https://modrinth.com/plugin/lunaticchat/version/${PAPER_VERSION}), [Velocity](https://modrinth.com/plugin/lunaticchat/version/${VELOCITY_VERSION}-velocity)
-
-          ## What's new
-
-          ### Highlights
-
-          ### New Features
-
-          ### Improvements
-
-          ### Changes
-
-          ### Bug Fixes
-
-          ### Notes
+          Release notes:
 
+          - [Paper/Folia v${PAPER_VERSION}](https://lc.m1sk9.dev/changelog/paper/v${PAPER_VERSION})
+          - [Velocity v${VELOCITY_VERSION}](https://lc.m1sk9.dev/changelog/velocity/v${VELOCITY_VERSION})
           EOF
 
           gh release create "$TAG_NAME" \
@@ -145,7 +125,7 @@ jobs:
           version: ${{ needs.validate.outputs.paper_version }}
           channel: ${{ env.MODRINTH_CHANNEL }}
           changelog: |-
-            Please refer to the [GitHub release](https://github.com/m1sk9/LunaticChat/releases/tag/${{ github.ref_name }}) for update details.
+            Please refer to the [release notes](https://lc.m1sk9.dev/changelog/paper/v${{ needs.validate.outputs.paper_version }}) for update details.
           loaders: |-
             paper
             folia
@@ -161,7 +141,7 @@ jobs:
           version: ${{ needs.validate.outputs.velocity_version }}-velocity
           channel: ${{ env.MODRINTH_CHANNEL }}
           changelog: |-
-            Please refer to the [GitHub release](https://github.com/m1sk9/LunaticChat/releases/tag/${{ github.ref_name }}) for update details.
+            Please refer to the [release notes](https://lc.m1sk9.dev/changelog/velocity/v${{ needs.validate.outputs.velocity_version }}) for update details.
           loaders: velocity
           game-versions: ${{ env.MODRINTH_VELOCITY_GAME_VERSIONS }}
           files: platform-velocity/build/libs/${{ needs.validate.outputs.velocity_jar_name }}