Skip to content

Commit d7e3eb1

Browse files
authored
Implement Release Drafter (#392)
1 parent f4a1d37 commit d7e3eb1

File tree

4 files changed

+103
-1
lines changed

4 files changed

+103
-1
lines changed

.github/release-drafter.yml

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
---
2+
name-template: "$RESOLVED_VERSION"
3+
tag-template: "$RESOLVED_VERSION"
4+
categories:
5+
- title: "💣 Breaking Change"
6+
labels:
7+
- "breaking change"
8+
- title: "🐛 Bug Fixes"
9+
labels:
10+
- "bug"
11+
- title: "⬆️ Dependencies"
12+
labels:
13+
- "dependencies"
14+
- title: "📝 Documentation"
15+
labels:
16+
- "documentation"
17+
- title: "🚀 Features"
18+
labels:
19+
- "feature"
20+
- title: "🎉 Enhancements"
21+
labels:
22+
- "enhancement"
23+
version-resolver:
24+
minor:
25+
labels:
26+
- "breaking change"
27+
patch:
28+
labels:
29+
- "bug"
30+
- "dependencies"
31+
- "documentation"
32+
- "feature"
33+
- "enhancement"
34+
default: patch
35+
autolabeler:
36+
- label: "documentation"
37+
branch:
38+
- "/docs\/.+/"
39+
files:
40+
- "*.md"
41+
- label: "bug"
42+
branch:
43+
- "/fix\/.+/"
44+
title:
45+
- "/fix/i"
46+
- label: "feature"
47+
branch:
48+
- "/feat\/.+/"
49+
- "/implement\/.+/"
50+
title:
51+
- "/implement/i"
52+
- label: "enhancement"
53+
branch:
54+
- "/add\/.+/"
55+
title:
56+
- "/add/i"
57+
- label: "dependencies"
58+
files:
59+
- ".github/workflows/requirements/*"
60+
branch:
61+
- "/bump\/.+/"
62+
title:
63+
- "/bump/i"
64+
template: |
65+
👾 *Help make the NGINX Ansible role better by participating in our [survey](https://forms.office.com/Pages/ResponsePage.aspx?id=L_093Ttq0UCb4L-DJ9gcUKLQ7uTJaE1PitM_37KR881UM0NCWkY5UlE5MUYyWU1aTUcxV0NRUllJSC4u)!* 👾
66+
67+
## What's new in NGINX's Ansible role $RESOLVED_VERSION!
68+
69+
$CHANGES
70+
71+
## Install & Upgrade
72+
73+
* To install the Ansible NGINX role on a fresh environment, run `ansible-galaxy install nginxinc.nginx`.
74+
* To upgrade the Ansible NGINX role to the latest release, run `ansible-galaxy install -f nginxinc.nginx`.
75+
* To install or upgrade to this specific Ansible NGINX role release ($RESOLVED_VERSION), run `ansible-galaxy install -f nginxinc.nginx,v$RESOLVED_VERSION`.
76+
77+
## Resources
78+
79+
* 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).
80+
* Ansible Galaxy repository -- [galaxy.ansible.com/nginxinc/nginx](https://galaxy.ansible.com/nginxinc/nginx).
81+
* NGINX Ansible role & collection introductory blog -- [nginx.com/blog/announcing-nginx-core-collection-ansible](https://www.nginx.com/blog/announcing-nginx-core-collection-ansible).
82+
* NGINX: Better with Ansible demo -- [github.com/alessfg/nginx-ansible-demo](https://github.com/alessfg/nginx-ansible-demo).

.github/workflows/release-drafter.yml

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
name: Release Drafter
3+
on:
4+
pull_request:
5+
types:
6+
- opened
7+
- reopened
8+
- synchronize
9+
push:
10+
branches:
11+
- main
12+
jobs:
13+
update_release_draft:
14+
name: Update release draft
15+
runs-on: ubuntu-20.04
16+
steps:
17+
- uses: release-drafter/release-drafter@v5
18+
env:
19+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ FEATURES:
1515
```
1616
* Explicitly list Jinja2 `2.11.3` as a requirement, as well as detail the minimum supported version (`2.11.x`).
1717
* Add support for Dependabot.
18+
* Initial implementation of Release Drafter.
1819

1920
ENHANCEMENTS:
2021

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ With the advent of Ansible collections and the release of the [NGINX Core Ansibl
4848

4949
### Ansible Galaxy
5050

51-
Use `ansible-galaxy install nginxinc.nginx` to install the latest stable release of the role on your system.
51+
Use `ansible-galaxy install nginxinc.nginx` to install the latest stable release of the role on your system. Alternatively, if you have already installed the role, use `ansible-galaxy install -f nginxinc.nginx` to update the role to the latest release.
5252

5353
### Git
5454

0 commit comments

Comments
 (0)