mirror of
https://github.com/Kong/insomnia.git
synced 2026-05-18 21:55:38 -04:00
manual changelog and release notes docs (#7282)
* chill vibes lofi * discard changelog job * magic generation * prompt
This commit is contained in:
34
.github/workflows/changelog.yml
vendored
34
.github/workflows/changelog.yml
vendored
@@ -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
|
||||
7
.github/workflows/release-build.yml
vendored
7
.github/workflows/release-build.yml
vendored
@@ -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>
|
||||
|
||||
|
||||
4
.github/workflows/release-publish.yml
vendored
4
.github/workflows/release-publish.yml
vendored
@@ -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
|
||||
|
||||
Reference in New Issue
Block a user