chore: Introduce release notes formatting + preview release action (#7247)

### What
- Add changelog formatting file to automate pull request categorization in release notes*
- Add action to trigger preview releases
- Remove unused staging deployment action

**Add changelog formatting file to automate pull request categorization in release notes**

In order for this work, we need to be more strict about our labels usage. More specifically, we need to add one of the four different labels noted in the `release.yml` file. The labels should be self-explanatory. If your PR introduces both features and bugs, you should choose the label based on importance of the changes.
This commit is contained in:
Oli Juhl
2024-05-06 14:59:37 +02:00
committed by GitHub
parent 36eff7f10a
commit 16528c57b0
3 changed files with 35 additions and 23 deletions

20
.github/release.yml vendored Normal file
View File

@@ -0,0 +1,20 @@
changelog:
exclude:
authors:
- github-actions
categories:
- title: Features
labels:
- "type: feature"
- title: Bugs
labels:
- "type: bug"
- title: Documentation
labels:
- "type: docs"
- title: Chores
labels:
- "type: chore"
- title: Other Changes
labels:
- "*"

View File

@@ -1,8 +1,18 @@
name: Staging Release and Publish
name: Trigger Release and Publish
on:
# TODO: Enabling manual workflow triggering while in pre-release mode. Remove when 1.8 is released
workflow_dispatch:
inputs:
version:
type: choice
default: 'preview'
description: What tag do you want to release?
required: true
options:
- preview
- next
- snapshot
- canary
branches:
- develop
paths-ignore:
@@ -15,7 +25,7 @@ concurrency: ${{ github.workflow }}-${{ github.ref }}
jobs:
release:
name: Staging Release
name: Trigger Release
runs-on: ubuntu-latest
steps:
- name: Checkout Repo
@@ -44,7 +54,7 @@ jobs:
run: yarn build
- name: Version packages
run: yarn version:next
run: yarn changeset version --snapshot ${{ github.event.inputs.version }}
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -52,4 +62,4 @@ jobs:
run: yarn install --no-immutable
- name: Publish packages under next tag
run: yarn release:next
run: yarn changeset publish --no-git-tags --snapshot --tag ${{ github.event.inputs.version }}

View File

@@ -1,18 +0,0 @@
name: Trigger staging deploy
on:
workflow_run:
workflows: [Staging Release and Publish]
types:
- completed
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- run: |
curl -X POST \
-H "Authorization: Bearer ${{secrets.STAGING_ACCESS_TOKEN}}" \
-H "Accept: application/vnd.github.v3+json" \
https://api.github.com/repos/@medusajs/medusa-staging/actions/workflows/deploy.yml/dispatches \
-d '{"ref":"main"}'