Skip to content

enhancement: add release drafter and pr template #33

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
### Breaking Changes
<!-- Optional - List any backward incompatible changes -->

### New Features
<!-- Optional - List new functionality added -->

### Bug Fixes
<!-- Optional - List bugs fixed in this release -->

### Checklist
- [ ] Version bumped
- [ ] Documentation updated
75 changes: 75 additions & 0 deletions .github/release-drafter-config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
name-template: "v$RESOLVED_VERSION 🚀"
tag-template: "v$RESOLVED_VERSION"
categories:
- title: "⚠️ Breaking Changes"
labels:
- "breaking"
- "major"
- title: "🚀 Features"
labels:
- "feature"
- "enhancement"
- title: "🐛 Bug Fixes"
labels:
- "fix"
- "bugfix"
- "bug"
- title: "🧰 Maintenance"
labels:
- "chore"
- "maintenance"
- title: "📚 Documentation"
labels:
- "documentation"
- title: "⬆️ Dependencies"
collapse-after: 5
labels:
- "dependencies"

change-template: "- $TITLE @$AUTHOR (#$NUMBER)"
change-title-escapes: '\<*_&'
version-resolver:
major:
labels:
- "major"
- "breaking"
minor:
labels:
- "minor"
- "feature"
patch:
labels:
- "patch"
- "fix"
- "bugfix"
- "bug"
default: patch

sort-by: "merged_at"
sort-direction: "descending"

exclude-labels:
- "skip-changelog"

autolabeler:
- label: "documentation"
files:
- "*.md"
- label: "bug"
branch:
- '/fix\/.+/'
title:
- "/fix/i"
- label: "feature"
branch:
- '/feature\/.+/'
- label: "dependencies"
files:
- "yarn.lock"

template: |
## Changes in Release v$RESOLVED_VERSION

$CHANGES

**Full Changelog**: https://github.com/$OWNER/$REPOSITORY/compare/$PREVIOUS_TAG...v$RESOLVED_VERSION
25 changes: 25 additions & 0 deletions .github/workflows/release-drafter.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: Release Drafter

on:
push:
branches:
- main
pull_request:
types: [opened, reopened, synchronize]
workflow_dispatch:

permissions:
contents: read

jobs:
update_release_draft:
permissions:
contents: write
pull-requests: write
runs-on: ubuntu-latest
steps:
- uses: release-drafter/release-drafter@v6
with:
config-name: release-drafter-config.yml
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
2 changes: 1 addition & 1 deletion .github/workflows/release-package.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ name: Release the Authsignal React Native package

on:
release:
types: [created]
types: [published]

jobs:
publish:
Expand Down
Loading