Skip to content

Commit

Permalink
chore: Introduce release notes formatting + preview release action (m…
Browse files Browse the repository at this point in the history
…edusajs#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.
  • Loading branch information
olivermrbl authored May 6, 2024
1 parent 36eff7f commit 16528c5
Show file tree
Hide file tree
Showing 3 changed files with 35 additions and 23 deletions.
20 changes: 20 additions & 0 deletions .github/release.yml
Original file line number Diff line number Diff line change
@@ -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:
- "*"
Original file line number Diff line number Diff line change
@@ -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:
Expand All @@ -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
Expand Down Expand Up @@ -44,12 +54,12 @@ 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 }}

- name: Install Dependencies
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 }}
18 changes: 0 additions & 18 deletions .github/workflows/trigger-staging-release.yml

This file was deleted.

0 comments on commit 16528c5

Please sign in to comment.