Skip to content

Commit 00e5825

Browse files
update labels/release (#149)
## 📝 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
1 parent 8ba7efc commit 00e5825

File tree

5 files changed

+101
-37
lines changed

5 files changed

+101
-37
lines changed

.github/labels.yml

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# PR Labels
2+
- name: new-feature
3+
description: for new features in the changelog.
4+
color: 225fee
5+
- name: improvement
6+
description: for improvements in existing functionality in the changelog.
7+
color: 22ee47
8+
- name: repo-ci-improvement
9+
description: for improvements in the repository or CI workflow in the changelog.
10+
color: c922ee
11+
- name: bugfix
12+
description: for any bug fixes in the changelog.
13+
color: ed8e21
14+
- name: documentation
15+
description: for updates to the documentation in the changelog.
16+
color: d3e1e6
17+
- name: dependencies
18+
description: dependency updates usually from dependabot
19+
color: 5c9dff
20+
- name: testing
21+
description: for updates to the testing suite in the changelog.
22+
color: 933ac9
23+
- name: breaking-change
24+
description: for breaking changes in the changelog.
25+
color: ff0000
26+
- name: ignore-for-release
27+
description: PRs you do not want to render in the changelog
28+
color: 7b8eac
29+
- name: do-not-merge
30+
description: PRs that should not be merged until the commented issue is resolved
31+
color: eb1515
32+
# Issue Labels
33+
- name: enhancement
34+
description: issues that request a enhancement
35+
color: 22ee47
36+
- name: bug
37+
description: issues that report a bug
38+
color: ed8e21

.github/release-drafter.yml

Lines changed: 0 additions & 21 deletions
This file was deleted.

.github/release.yml

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
changelog:
2+
exclude:
3+
labels:
4+
- ignore-for-release
5+
categories:
6+
- title: ⚠️ Breaking Change
7+
labels:
8+
- breaking-change
9+
- title: 🐛 Bug Fixes
10+
labels:
11+
- bugfix
12+
- title: 🚀 New Features
13+
labels:
14+
- new-feature
15+
- title: 💡 Improvements
16+
labels:
17+
- improvement
18+
- title: 🧪 Testing Improvements
19+
labels:
20+
- testing
21+
- title: ⚙️ Repo/CI Improvements
22+
labels:
23+
- repo-ci-improvement
24+
- title: 📖 Documentation
25+
labels:
26+
- documentation
27+
- title: 📦 Dependency Updates
28+
labels:
29+
- dependencies
30+
- title: Other Changes
31+
labels:
32+
- "*"

.github/workflows/labeler.yml

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: labeler
2+
3+
on:
4+
push:
5+
branches:
6+
- 'main'
7+
paths:
8+
- '.github/labels.yml'
9+
- '.github/workflows/labeler.yml'
10+
pull_request:
11+
paths:
12+
- '.github/labels.yml'
13+
- '.github/workflows/labeler.yml'
14+
15+
jobs:
16+
labeler:
17+
runs-on: ubuntu-latest
18+
steps:
19+
-
20+
name: Checkout
21+
uses: actions/checkout@v4
22+
-
23+
name: Run Labeler
24+
uses: crazy-max/ghaction-github-labeler@de749cf181958193cb7debf1a9c5bb28922f3e1b
25+
with:
26+
github-token: ${{ secrets.GITHUB_TOKEN }}
27+
yaml-file: .github/labels.yml
28+
dry-run: ${{ github.event_name == 'pull_request' }}
29+
exclude: |
30+
help*
31+
*issue

.github/workflows/release-drafter.yml

Lines changed: 0 additions & 16 deletions
This file was deleted.

0 commit comments

Comments
 (0)