Implement Release Drafter (#392)

This commit is contained in:
Alessandro Fael Garcia 2021-04-28 13:23:22 +02:00 committed by GitHub
parent f4a1d37081
commit d7e3eb1f55
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 103 additions and 1 deletions

82
.github/release-drafter.yml vendored Normal file
View File

@ -0,0 +1,82 @@
---
name-template: "$RESOLVED_VERSION"
tag-template: "$RESOLVED_VERSION"
categories:
- title: "💣 Breaking Change"
labels:
- "breaking change"
- title: "🐛 Bug Fixes"
labels:
- "bug"
- title: "⬆️ Dependencies"
labels:
- "dependencies"
- title: "📝 Documentation"
labels:
- "documentation"
- title: "🚀 Features"
labels:
- "feature"
- title: "🎉 Enhancements"
labels:
- "enhancement"
version-resolver:
minor:
labels:
- "breaking change"
patch:
labels:
- "bug"
- "dependencies"
- "documentation"
- "feature"
- "enhancement"
default: patch
autolabeler:
- label: "documentation"
branch:
- "/docs\/.+/"
files:
- "*.md"
- label: "bug"
branch:
- "/fix\/.+/"
title:
- "/fix/i"
- label: "feature"
branch:
- "/feat\/.+/"
- "/implement\/.+/"
title:
- "/implement/i"
- label: "enhancement"
branch:
- "/add\/.+/"
title:
- "/add/i"
- label: "dependencies"
files:
- ".github/workflows/requirements/*"
branch:
- "/bump\/.+/"
title:
- "/bump/i"
template: |
👾 *Help make the NGINX Ansible role better by participating in our [survey](https://forms.office.com/Pages/ResponsePage.aspx?id=L_093Ttq0UCb4L-DJ9gcUKLQ7uTJaE1PitM_37KR881UM0NCWkY5UlE5MUYyWU1aTUcxV0NRUllJSC4u)!* 👾
## What's new in NGINX's Ansible role $RESOLVED_VERSION!
$CHANGES
## Install & Upgrade
* To install the Ansible NGINX role on a fresh environment, run `ansible-galaxy install nginxinc.nginx`.
* To upgrade the Ansible NGINX role to the latest release, run `ansible-galaxy install -f nginxinc.nginx`.
* To install or upgrade to this specific Ansible NGINX role release ($RESOLVED_VERSION), run `ansible-galaxy install -f nginxinc.nginx,v$RESOLVED_VERSION`.
## Resources
* 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).
* Ansible Galaxy repository -- [galaxy.ansible.com/nginxinc/nginx](https://galaxy.ansible.com/nginxinc/nginx).
* NGINX Ansible role & collection introductory blog -- [nginx.com/blog/announcing-nginx-core-collection-ansible](https://www.nginx.com/blog/announcing-nginx-core-collection-ansible).
* NGINX: Better with Ansible demo -- [github.com/alessfg/nginx-ansible-demo](https://github.com/alessfg/nginx-ansible-demo).

19
.github/workflows/release-drafter.yml vendored Normal file
View File

@ -0,0 +1,19 @@
---
name: Release Drafter
on:
pull_request:
types:
- opened
- reopened
- synchronize
push:
branches:
- main
jobs:
update_release_draft:
name: Update release draft
runs-on: ubuntu-20.04
steps:
- uses: release-drafter/release-drafter@v5
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

View File

@ -15,6 +15,7 @@ FEATURES:
```
* Explicitly list Jinja2 `2.11.3` as a requirement, as well as detail the minimum supported version (`2.11.x`).
* Add support for Dependabot.
* Initial implementation of Release Drafter.
ENHANCEMENTS:

View File

@ -48,7 +48,7 @@ With the advent of Ansible collections and the release of the [NGINX Core Ansibl
### Ansible Galaxy
Use `ansible-galaxy install nginxinc.nginx` to install the latest stable release of the role on your system.
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.
### Git