manual changelog and release notes docs (#7282)

* chill vibes lofi

* discard changelog job

* magic generation

* prompt
This commit is contained in:
Jack Kavanagh
2024-04-19 10:50:44 +02:00
committed by GitHub
parent 883f907ac0
commit 7062f07f7d
3 changed files with 9 additions and 36 deletions

View File

@@ -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

View File

@@ -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>

View File

@@ -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