Skip to content

Commit b2f716c

Browse files
committed
feat: Use release drafter
1 parent 0f4d698 commit b2f716c

File tree

3 files changed

+142
-33
lines changed

3 files changed

+142
-33
lines changed

.github/release-drafter.yml

+117
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,117 @@
1+
---
2+
name-template: $RESOLVED_VERSION
3+
tag-template: $RESOLVED_VERSION
4+
include-pre-releases: true
5+
categories:
6+
- title: 💣 Breaking Changes
7+
labels:
8+
- breaking change
9+
- title: 🔔 Deprecation Warnings
10+
labels:
11+
- deprecation
12+
- title: 🚀 Features
13+
labels:
14+
- enhancement
15+
- title: 🐛 Bug Fixes
16+
labels:
17+
- bug
18+
- title: 🧪 Tests
19+
labels:
20+
- tests
21+
- title: 📝 Documentation
22+
labels:
23+
- documentation
24+
- title: 👷 CI/CD
25+
labels:
26+
- ci
27+
- build
28+
- title: 🔨 Maintenance
29+
labels:
30+
- chore
31+
- title: ⬆️ Dependencies
32+
collapse-after: 15
33+
labels:
34+
- dependencies
35+
- title: Other Changes
36+
labels:
37+
- *
38+
exclude-labels:
39+
- skip changelog
40+
version-resolver:
41+
minor:
42+
labels:
43+
- breaking change
44+
- deprecation
45+
patch:
46+
labels:
47+
- bug
48+
- chore
49+
- dependencies
50+
- documentation
51+
- enhancement
52+
- tests
53+
default: patch
54+
autolabeler:
55+
- label: breaking change
56+
body:
57+
- "/breaking/i"
58+
- label: deprecation
59+
branch:
60+
- "/deprecate\/.+/"
61+
title:
62+
- "/deprecate/i"
63+
- label: enhancement
64+
branch:
65+
- "/feat\/.+/"
66+
- "/feature\/.+/"
67+
title:
68+
- "/feat/i"
69+
- "/feature/i"
70+
- label: bug
71+
branch:
72+
- "/fix\/.+/"
73+
- "/bug\/.+/"
74+
- "/bugfix\/.+/"
75+
title:
76+
- "/fix/i"
77+
- "/bug/i"
78+
- "/bugfix/i"
79+
- label: tests
80+
branch:
81+
- "/tests{0,1}\/.+/"
82+
files:
83+
- "/tests/**"
84+
title:
85+
- "/tests{0,1}\/.+/i"
86+
- label: documentation
87+
branch:
88+
- "/docs{0,1}\/.+/"
89+
- "/documentation\/.+/"
90+
files:
91+
- "docs/**"
92+
title:
93+
- "/docs{0,1}\/.+/i"
94+
- "/documentation/i"
95+
- label: dependencies #todo review
96+
files:
97+
- ".github/workflows/requirements/*"
98+
replacers: #todo review
99+
- search: "/(feat|fix|docs|chore|cleanup|style|refactor|perf|test)(\(\w+\))?: /g"
100+
replace: ""
101+
template: |
102+
## What's new in the NGINX S3 Gateway v$RESOLVED_VERSION!
103+
104+
$CHANGES
105+
106+
## Install & Upgrade ## TODO Update or remove
107+
108+
- To install the Ansible NGINX role on a fresh environment, run `ansible-galaxy install nginxinc.nginx`.
109+
- To upgrade the Ansible NGINX role to the latest release, run `ansible-galaxy install -f nginxinc.nginx`.
110+
- To install or upgrade to this specific Ansible NGINX role release ($RESOLVED_VERSION), run `ansible-galaxy install -f nginxinc.nginx,v$RESOLVED_VERSION`.
111+
112+
## Resources ## TODO Update or remove
113+
114+
- Functional configuration examples (check `converge.yml` under each `molecule` scenario) -- [github.com/nginxinc/ansible-role-nginx/tree/$RESOLVED_VERSION/molecule](https://github.com/nginxinc/ansible-role-nginx/tree/$RESOLVED_VERSION/molecule).
115+
- Ansible Galaxy repository -- [galaxy.ansible.com/nginxinc/nginx](https://galaxy.ansible.com/nginxinc/nginx).
116+
- NGINX Ansible role & collection introductory blog -- [nginx.com/blog/announcing-nginx-core-collection-ansible](https://www.nginx.com/blog/announcing-nginx-core-collection-ansible).
117+
- NGINX: Better with Ansible demo -- [github.com/alessfg/nginx-ansible-demo](https://github.com/alessfg/nginx-ansible-demo).

.github/release.yml

-33
This file was deleted.

.github/workflows/release.yml

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
name: Release Drafter
3+
on:
4+
push:
5+
branches: [main]
6+
# pull_request_target event is required for autolabeler to support PRs from forks
7+
pull_request_target:
8+
# Only following types are handled by the action, but one can default to all as well
9+
types: [opened, reopened, synchronize]
10+
11+
permissions: read-all
12+
jobs:
13+
update_release_draft:
14+
permissions:
15+
# write permission is required to create a github release
16+
contents: write
17+
# write permission is required for autolabeler
18+
# otherwise, read permission is required at least
19+
pull-requests: write
20+
runs-on: ubuntu-24.04
21+
steps:
22+
- name: Run Release Drafter
23+
uses: release-drafter/release-drafter@3f0f87098bd6b5c5b9a36d49c41d998ea58f9348 # v6.0.0
24+
env:
25+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

0 commit comments

Comments
 (0)