Skip to content
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

feat: Generate release notes #289

Open
wants to merge 6 commits 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
110 changes: 110 additions & 0 deletions .github/release-drafter.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,110 @@
---
name-template: $RESOLVED_VERSION
tag-template: $RESOLVED_VERSION
include-pre-releases: true
categories:
- title: 💣 Breaking Changes
labels:
- breaking change
- title: 🔔 Deprecation Warnings
labels:
- deprecation
- title: 🚀 Features
labels:
- enhancement
- title: 🐛 Bug Fixes
labels:
- bug
- title: 🧪 Tests
labels:
- tests
- title: 📝 Documentation
labels:
- documentation
- title: 👷 CI/CD
labels:
- ci
- build
- title: 🔨 Maintenance
labels:
- chore
- title: ⬆️ Dependencies
collapse-after: 15
labels:
- dependencies
- title: Other Changes
labels:
- *
exclude-labels:
- skip changelog
version-resolver:
minor:
labels:
- breaking change
- deprecation
patch:
labels:
- bug
- chore
- dependencies
- documentation
- enhancement
- tests
default: patch
autolabeler:
- label: breaking change
body:
- "/breaking/i"
- label: deprecation
branch:
- "/deprecate\/.+/"
title:
- "/deprecate/i"
- label: enhancement
branch:
- "/feat\/.+/"
- "/feature\/.+/"
title:
- "/feat/i"
- "/feature/i"
- label: bug
branch:
- "/fix\/.+/"
- "/bug\/.+/"
- "/bugfix\/.+/"
title:
- "/fix/i"
- "/bug/i"
- "/bugfix/i"
- label: tests
branch:
- "/tests{0,1}\/.+/"
files:
- "/tests/**"
title:
- "/tests{0,1}\/.+/i"
- label: documentation
branch:
- "/docs{0,1}\/.+/"
- "/documentation\/.+/"
files:
- "docs/**"
title:
- "/docs{0,1}\/.+/i"
- "/documentation/i"
- label: dependencies #todo review
files:
- ".github/workflows/requirements/*"
replacers: #todo review
- search: "/(feat|fix|docs|chore|cleanup|style|refactor|perf|test)(\(\w+\))?: /g"
replace: ""
template: |
## What's new in the NGINX S3 Gateway $RESOLVED_VERSION!

$CHANGES

## Install & Upgrade

- The easiest way to use the most recent version is to find it in the [docker images](https://github.com/nginxinc/nginx-s3-gateway/pkgs/container/nginx-s3-gateway%2Fnginx-oss-s3-gateway) are which contains installation instructions
- Detailed installation and configuration instructions can be found in the [Getting Started Guide](https://github.com/nginxinc/nginx-s3-gateway/blob/main/docs/getting_started.md)

25 changes: 25 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
name: Release Drafter
on:
push:
branches: [main]
# pull_request_target event is required for autolabeler to support PRs from forks
pull_request_target:
# Only following types are handled by the action, but one can default to all as well
types: [opened, reopened, synchronize]

permissions: read-all
jobs:
update_release_draft:
permissions:
# write permission is required to create a github release
contents: write
# write permission is required for autolabeler
# otherwise, read permission is required at least
pull-requests: write
runs-on: ubuntu-24.04
steps:
- name: Run Release Drafter
uses: release-drafter/release-drafter@3f0f87098bd6b5c5b9a36d49c41d998ea58f9348 # v6.0.0
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
Loading