Implement Release Drafter (#83)

Author: alessfg

.github/release-drafter.yml

@@ -0,0 +1,106 @@
+---
+name-template: "$RESOLVED_VERSION"
+tag-template: "$RESOLVED_VERSION"
+categories:
+  - title: "💣 Breaking Changes"
+    labels:
+      - "breaking change"
+  - title: "🔔 Deprecation Warnings"
+    labels:
+      - "deprecation"
+  - title: "🚀 Features"
+    labels:
+      - "feature"
+  - title: "🎉 Enhancements"
+    labels:
+      - "enhancement"
+  - title: "🐛 Bug Fixes"
+    labels:
+      - "bug"
+  - title: "📝 Documentation"
+    labels:
+      - "documentation"
+  - title: "⬆️ Dependencies"
+    labels:
+      - "dependencies"
+exclude-labels:
+  - "skip-changelog"
+version-resolver:
+  minor:
+    labels:
+      - "breaking change"
+      - "deprecation"
+  patch:
+    labels:
+      - "bug"
+      - "dependencies"
+      - "documentation"
+      - "feature"
+      - "enhancement"
+  default: patch
+autolabeler:
+  - label: "breaking change"
+    body:
+      - "/breaking/i"
+  - label: "deprecation"
+    branch:
+      - "/deprecate\/.+/"
+    title:
+      - "/deprecate/i"
+  - label: "feature"
+    branch:
+      - "/feat\/.+/"
+      - "/feature\/.+/"
+      - "/implement\/.+/"
+    title:
+      - "/feat/i"
+      - "/feature/i"
+      - "/implement/i"
+  - label: "enhancement"
+    branch:
+      - "/add\/.+/"
+      - "/enhancement\/.+/"
+    title:
+      - "/add/i"
+      - "/enhancement/i"
+  - label: "bug"
+    branch:
+      - "/fix\/.+/"
+    title:
+      - "/fix/i"
+  - label: "documentation"
+    branch:
+      - "/docs\/.+/"
+    files:
+      - "*.md"
+    title:
+      - "/docs/i"
+      - "/documentation/i"
+  - label: "dependencies"
+    files:
+      - ".github/workflows/requirements/*"
+    branch:
+      - "/bump\/.+/"
+      - "/update\/.+/"
+    title:
+      - "/bump/i"
+      - "/update/i"
+template: |
+  👾 *Help make the NGINX App Protect 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 App Protect Ansible role $RESOLVED_VERSION!
+
+  $CHANGES
+
+  ## Install & Upgrade
+
+  *   To install the Ansible NGINX App Protect role on a fresh environment, run `ansible-galaxy install nginxinc.nginx_app_protect`.
+  *   To upgrade the Ansible NGINX App Protect role to the latest release, run `ansible-galaxy install -f nginxinc.nginx_app_protect`.
+  *   To install or upgrade to this specific Ansible NGINX App Protect role release ($RESOLVED_VERSION), run `ansible-galaxy install -f nginxinc.nginx_app_protect,v$RESOLVED_VERSION`.
+
+  ## Resources
+
+  *   Functional configuration examples (check `converge.yml` under each `molecule` scenario) -- [github.com/nginxinc/ansible-role-nginx-app-protect/tree/$RESOLVED_VERSION/molecule](https://github.com/nginxinc/ansible-role-nginx-app-protect/tree/$RESOLVED_VERSION/molecule).
+  *   Ansible Galaxy repository -- [galaxy.ansible.com/nginxinc/nginx](https://galaxy.ansible.com/nginxinc/nginx_app_protect).
+  *   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).

.github/workflows/release-drafter.yml

@@ -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 }}

CHANGELOG.md

@@ -1,6 +1,10 @@
 # Changelog
 
-## 0.4.4 (Unreleased)
+## 0.5.0 (Unreleased)
+
+FEATURES:
+
+Implement Release Drafter.
 
 ENHANCEMENTS:
 
@@ -10,6 +14,10 @@ ENHANCEMENTS:
 
 ## 0.4.3 (April 6, 2020)
 
+BREAKING CHANGES:
+
+The `nginx_app_protect_version` variable has been removed, as it cannot be implemented fully on all platforms.
+
 FEATURES:
 
 *   Add support for Dependabot.
@@ -39,10 +47,6 @@ ENHANCEMENTS:
 *   Minor GitHub template tweaks, including the creation of a SECURITY doc.
 *   Only run GitHub actions Galaxy CI/CD workflow when a new release is published.
 
-BREAKING CHANGES:
-
-The `nginx_app_protect_version` variable has been removed, as it cannot be implemented fully on all platforms.
-
 KNOWN ISSUES:
 
 Service manager support is not included in NGINX App Protect for Alpine. When using this role to install NGINX App Protect on Alpine, you will need to start the NGINX App Protect processes then reload NGINX Plus yourself in order for App Protect to function. You can use commands similar to what are contained in the `entrypoint.sh` script in the [NGINX App Protect Administration Guide](https://docs.nginx.com/nginx-app-protect/admin-guide/install/#docker-deployment-instructions) to accomplish this.
@@ -67,7 +71,7 @@ Update Ansible (now Ansible base) to `2.10.3`, Ansible (now Ansible Community Di
 
 ## 0.4.0 (November 16, 2020)
 
-DEPRECATION WARNING:
+DEPRECATION WARNINGS:
 
 The ability to dynamically create App Protect security and log policies via Jinja2 templates will be removed in a future release, as they weren't used much due to relative inflexibility. The `nginx_app_protect_security_policy_file_enable`, `nginx_app_protect_security_policy_file_*`, `nginx_app_protect_log_policy_file_enable` and `nginx_app_protect_log_policy_file_*` variables should be used instead of the `nginx_app_protect_*_policy_template*` variables. These new variables have been introduced in this release.