Skip to content

Commit

Permalink
update labels/release (#149)
Browse files Browse the repository at this point in the history
## 📝 Description

**What does this PR do and why is this change necessary?**

Updates to use githubs built in release notes and using the following labels.

`**NOTE**: The labeler job is dry running on the PR to show what it will do, doesn't execute until we merge.`

### ⚠️  Breaking Change
breaking-change: any changes that break end users or downstream workflows
### 🐛 Bug Fixes
bugfix: changes that fix a existing bug
### 🚀 New Features
new-feature: changes that add new features such as endpoints or tools
### 💡 Improvements
improvement: changes that improve existing features or reflect small API changes
### 🧪 Testing Improvements
testing: improvements to the testing workflows
### ⚙️  Repo/CI Improvements
repo-ci-improvement: improvements to the CI workflow, like this PR!
### 📖 Documentation
documentation: updates to the package/repo documentation or wiki
### 📦 Dependency Updates
dependencies: Used by dependabot mostly
### Ignore For Release
ignore-for-release: for PRs you dont want rendered in the changelog, usually the release merge to main
  • Loading branch information
jriddle-linode authored Apr 9, 2024
1 parent 8ba7efc commit 00e5825
Show file tree
Hide file tree
Showing 5 changed files with 101 additions and 37 deletions.
38 changes: 38 additions & 0 deletions .github/labels.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# PR Labels
- name: new-feature
description: for new features in the changelog.
color: 225fee
- name: improvement
description: for improvements in existing functionality in the changelog.
color: 22ee47
- name: repo-ci-improvement
description: for improvements in the repository or CI workflow in the changelog.
color: c922ee
- name: bugfix
description: for any bug fixes in the changelog.
color: ed8e21
- name: documentation
description: for updates to the documentation in the changelog.
color: d3e1e6
- name: dependencies
description: dependency updates usually from dependabot
color: 5c9dff
- name: testing
description: for updates to the testing suite in the changelog.
color: 933ac9
- name: breaking-change
description: for breaking changes in the changelog.
color: ff0000
- name: ignore-for-release
description: PRs you do not want to render in the changelog
color: 7b8eac
- name: do-not-merge
description: PRs that should not be merged until the commented issue is resolved
color: eb1515
# Issue Labels
- name: enhancement
description: issues that request a enhancement
color: 22ee47
- name: bug
description: issues that report a bug
color: ed8e21
21 changes: 0 additions & 21 deletions .github/release-drafter.yml

This file was deleted.

32 changes: 32 additions & 0 deletions .github/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
changelog:
exclude:
labels:
- ignore-for-release
categories:
- title: ⚠️ Breaking Change
labels:
- breaking-change
- title: 🐛 Bug Fixes
labels:
- bugfix
- title: 🚀 New Features
labels:
- new-feature
- title: 💡 Improvements
labels:
- improvement
- title: 🧪 Testing Improvements
labels:
- testing
- title: ⚙️ Repo/CI Improvements
labels:
- repo-ci-improvement
- title: 📖 Documentation
labels:
- documentation
- title: 📦 Dependency Updates
labels:
- dependencies
- title: Other Changes
labels:
- "*"
31 changes: 31 additions & 0 deletions .github/workflows/labeler.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: labeler

on:
push:
branches:
- 'main'
paths:
- '.github/labels.yml'
- '.github/workflows/labeler.yml'
pull_request:
paths:
- '.github/labels.yml'
- '.github/workflows/labeler.yml'

jobs:
labeler:
runs-on: ubuntu-latest
steps:
-
name: Checkout
uses: actions/checkout@v4
-
name: Run Labeler
uses: crazy-max/ghaction-github-labeler@de749cf181958193cb7debf1a9c5bb28922f3e1b
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
yaml-file: .github/labels.yml
dry-run: ${{ github.event_name == 'pull_request' }}
exclude: |
help*
*issue
16 changes: 0 additions & 16 deletions .github/workflows/release-drafter.yml

This file was deleted.

0 comments on commit 00e5825

Please sign in to comment.