From 7062f07f7d4b5f3be438fef8294cfaafe055b74a Mon Sep 17 00:00:00 2001
From: Jack Kavanagh <jackkav@gmail.com>
Date: Fri, 19 Apr 2024 10:50:44 +0200
Subject: [PATCH] manual changelog and release notes docs (#7282)

* chill vibes lofi

* discard changelog job

* magic generation

* prompt
---
 .github/workflows/changelog.yml       | 34 ---------------------------
 .github/workflows/release-build.yml   |  7 ++++++
 .github/workflows/release-publish.yml |  4 ++--
 3 files changed, 9 insertions(+), 36 deletions(-)
 delete mode 100644 .github/workflows/changelog.yml

diff --git a/.github/workflows/changelog.yml b/.github/workflows/changelog.yml
deleted file mode 100644
index 7106ad072e..0000000000
--- a/.github/workflows/changelog.yml
+++ /dev/null
@@ -1,34 +0,0 @@
-name: Update changelog
-
-on:
-  workflow_dispatch:
-    inputs:
-      version:
-        required: true
-        description: Release version (e.g. 2022.1.0 or 2022.1.0-beta.0)
-  push:
-    tags:
-      - core@(\d+\.\d+\.\d+)(?:-(alpha|beta)\.\d+)?
-
-
-jobs:
-  changelog:
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Checkout Code
-        uses: actions/checkout@v3
-
-      - name: Update CHANGELOG
-        id: changelog
-        uses: requarks/changelog-action@v1
-        with:
-          token: ${{ secrets.RELEASE_GH_TOKEN }}
-          tag: ${{ github.event.inputs.version || github.ref_name }}
-
-      - name: Commit CHANGELOG.md
-        uses: stefanzweifel/git-auto-commit-action@v4
-        with:
-          branch: develop
-          commit_message: 'docs: update CHANGELOG.md for ${{ github.event.inputs.version || github.ref_name }} [skip ci]'
-          file_pattern: CHANGELOG.md
diff --git a/.github/workflows/release-build.yml b/.github/workflows/release-build.yml
index 0f2893c5c8..85320ac770 100644
--- a/.github/workflows/release-build.yml
+++ b/.github/workflows/release-build.yml
@@ -167,6 +167,11 @@ jobs:
 
             ## Steps for Publish:
 
+            You can update the changelog.md in this branch, run git log to get the latest changes:
+            ```bash
+            git log --no-merges --oneline --pretty=format:'* %s by @%an' --since="<last release tag>" --until="release/${{ steps.release_version.outputs.version }}"
+            ```
+
             When ready to publish, trigger [Publish](https://github.com/${{ github.repository }}/actions/workflows/release-publish.yml) workflow with these variables:
             - Release version (`version`): `${{ steps.release_version.outputs.version }}`
 
@@ -175,6 +180,8 @@ jobs:
             gh workflow run release-publish.yml -f version=${{ steps.release_version.outputs.version }} --repo ${{ github.repository }}
             ```
 
+            Release notes will be generated automatically based on the commit messages during publish. Remove any unwanted notes manually afterwards.
+
             <details>
             <summary>Conflicts? Merge branch step failed on the publish workflow? Try this...</summary>
 
diff --git a/.github/workflows/release-publish.yml b/.github/workflows/release-publish.yml
index dab2715e63..b4dd8be281 100644
--- a/.github/workflows/release-publish.yml
+++ b/.github/workflows/release-publish.yml
@@ -81,7 +81,7 @@ jobs:
         with:
           tag: lib@${{ env.INSO_VERSION }}
           name: "Inso CLI ${{ env.INSO_VERSION }} 📦"
-          body: "Full changelog ⇒ https://insomnia.rest/changelog"
+          generateReleaseNotes: false
           commit: ${{ env.RELEASE_BRANCH }}
           prerelease: ${{ env.IS_PRERELEASE }}
           draft: false
@@ -105,7 +105,7 @@ jobs:
         with:
           tag: ${{ env.RELEASE_CORE_TAG }}
           name: "Insomnia ${{ env.RELEASE_VERSION }} 📦"
-          body: "Full changelog ⇒ https://insomnia.rest/changelog"
+          generateReleaseNotes: true
           commit: ${{ env.RELEASE_BRANCH }}
           prerelease: ${{ env.IS_PRERELEASE }}
           draft: false