Skip to content
This repository has been archived by the owner on Aug 2, 2022. It is now read-only.

Commit

Permalink
Adds workflow to generate draft release notes and reformat old releas…
Browse files Browse the repository at this point in the history
…e notes (#241)

* Add a config file to organize all labeled PRs and place under headers in the release notes
* Add a workflow to create draft release notes under ‘Releases’ tab in GitHub
* Reformat old release notes to meet the unified standard
  • Loading branch information
ftianli-amzn authored Aug 25, 2020
1 parent 07762df commit 91f0650
Show file tree
Hide file tree
Showing 28 changed files with 175 additions and 84 deletions.
41 changes: 41 additions & 0 deletions .github/draft-release-notes-config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# The overall template of the release notes
template: |
Compatible with Elasticsearch (**set version here**).
$CHANGES
# Setting the formatting and sorting for the release notes body
name-template: Version (set version here)
change-template: '* $TITLE (#$NUMBER)'
sort-by: merged_at
sort-direction: ascending
replacers:
- search: '##'
replace: '###'

# Organizing the tagged PRs into unified ODFE categories
categories:
- title: 'Breaking changes'
labels:
- 'breaking change'
- title: 'Features'
labels:
- 'feature'
- title: 'Enhancements'
labels:
- 'enhancement'
- title: 'Bug Fixes'
labels:
- 'bug'
- title: 'Infrastructure'
labels:
- 'build'
- 'testing'
- title: 'Documentation'
labels:
- 'documentation'
- title: 'Maintenance'
labels:
- 'version compatibility'
- title: 'Refactoring'
labels:
- 'refactor'
20 changes: 20 additions & 0 deletions .github/workflows/draft-release-notes-workflow.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
name: Release Drafter

on:
push:
branches:
- master

jobs:
update_release_draft:
name: Update draft release notes
runs-on: ubuntu-latest
steps:
- name: Update draft release notes
uses: release-drafter/release-drafter@v5
with:
config-name: draft-release-notes-config.yml
name: Version (set here)
tag: (None)
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## 2019-01-31, Version 0.7.0.0

### New Features
### Features

This is the first release of the OpenDistro Elasticsearch Alerting plugin.

Expand All @@ -11,14 +11,14 @@ Actions are messages using mustache templating created by the user that are sent
Destinations are locations where action messages are sent, such as email server, slack, chime, or custom webhooks.
Alerts can be acknowledged to mute notifications.

Adds backend REST API used for basic CRUD, search operations, and testing on monitors as well as acknowledging alerts.
* Adds backend REST API used for basic CRUD, search operations, and testing on monitors as well as acknowledging alerts.

Adds configuration API to enable/disable monitoring.
* Adds configuration API to enable/disable monitoring.

Adds stats API to check the status of plugin and ensure everything is working as expected.
* Adds stats API to check the status of plugin and ensure everything is working as expected.

Adds API support for create, update, and deleting destinations.
* Adds API support for create, update, and deleting destinations.

### Commits
#### Commits

* [[`4771e6c`](https://github.com/mauve-hedgehog/opendistro-elasticsearch-alerting/commit/4771e6c5ce6f541fc84f1290ac2fd43f64f3dcb2)] Initial release for OpenDistro Elasticsearch Alerting
* [`4771e6c`](https://github.com/mauve-hedgehog/opendistro-elasticsearch-alerting/commit/4771e6c5ce6f541fc84f1290ac2fd43f64f3dcb2) Initial release for OpenDistro Elasticsearch Alerting
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
## 2019-04-02, Version 0.8.0.0

### Bug Fixes
* Fixed task name in build instructions ([#12](https://github.com/opendistro-for-elasticsearch/alerting/pull/12))

### Maintenance
* Adds support for Elasticsearch 6.6.2 ([#8](https://github.com/opendistro-for-elasticsearch/alerting/pull/8))
* Upgrade to latest Kotlin version ([#7](https://github.com/opendistro-for-elasticsearch/alerting/pull/7))
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
## 2019-04-24, Version 0.9.0.0

### Features
* Add http proxy support to outgoing notifications ([#23](https://github.com/opendistro-for-elasticsearch/alerting/pull/23))
* Allow encoding while constructing HTTP request for sending notification ([#35](https://github.com/opendistro-for-elasticsearch/alerting/pull/35))
* Add build for Debian ([#36](https://github.com/opendistro-for-elasticsearch/alerting/pull/36))

### Bug Fixes
* Fix update LastFullSweepTime if the index doesn't exist ([#17](https://github.com/opendistro-for-elasticsearch/alerting/pull/17))
* Adds more alert properties to templateArgs for context variable ([#26](https://github.com/opendistro-for-elasticsearch/alerting/pull/26))

### Maintenance
* Adds support for Elasticsearch 6.7.1 ([#19](https://github.com/opendistro-for-elasticsearch/alerting/pull/19))
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
## 2019-06-25, Version 1.0.0.0

### Features
* Adds support for throttling on actions ([#48](https://github.com/opendistro-for-elasticsearch/alerting/pull/48))

### Bug Fixes
* Validate all 2XX status code in Webhook response ([#50](https://github.com/opendistro-for-elasticsearch/alerting/pull/50))
* Allows encoding while constructing HTTP request for sending notification ([#35](https://github.com/opendistro-for-elasticsearch/alerting/pull/35))
* Convert AlertMover/MonitorRunner to coroutines ([#11](https://github.com/opendistro-for-elasticsearch/alerting/pull/11))

### Maintenance
* Adds support for Elasticsearch 7.0.1 ([#41](https://github.com/opendistro-for-elasticsearch/alerting/pull/41))
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
## 2019-07-25, Version 1.1.0.0

### Features
* Return stack trace for errors in Groovy/Painless script in UI when creating a trigger ([#72](https://github.com/opendistro-for-elasticsearch/alerting/pull/72))

### Maintenance
* Adds support for Elasticsearch 7.1.1 ([#74](https://github.com/opendistro-for-elasticsearch/alerting/pull/74))
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
## 2020-08-18, Version 1.10.0.0

Compatible with Elasticsearch 7.9.0

### Enhancements
* Add action to 'DELETE /_alerting/destinations/{id}' ([#233](https://github.com/opendistro-for-elasticsearch/alerting/pull/233))
* Add action to '/_alerting/monitor/{id}', '/_alerting/monitor/_search' ([#234](https://github.com/opendistro-for-elasticsearch/alerting/pull/234))
* Add action to 'CREATE /_alerting/destinations/' ([#235](https://github.com/opendistro-for-elasticsearch/alerting/pull/235))

### Infrastructure
* Support integration testing against remote security enabled clustering ([#213](https://github.com/opendistro-for-elasticsearch/alerting/pull/213))
* Add coverage upload in build workflow and add badges in README ([#223](https://github.com/opendistro-for-elasticsearch/alerting/pull/223))
* Add Codecov configuration to set a coverage threshold to pass the check on a commit ([#231](https://github.com/opendistro-for-elasticsearch/alerting/pull/231))

### Maintenance
* Adds support for Elasticsearch 7.9.0 ([#238](https://github.com/opendistro-for-elasticsearch/alerting/pull/238))
* Upgrade the vulnerable dependencies versions of Kotlin and 'commons-codec' ([#230](https://github.com/opendistro-for-elasticsearch/alerting/pull/230))
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
## 2019-09-20, Version 1.2.0.0

### Bug Fixes
* Fixes integTestRunner build task ([#83](https://github.com/opendistro-for-elasticsearch/alerting/pull/83))

### Maintenance
* Adds support for Elasticsearch 7.2.0 ([#89](https://github.com/opendistro-for-elasticsearch/alerting/pull/89))
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
## 2019-09-24, Version 1.2.0.1

### Bug Fixes
* Updated execute API to keep thread context ([#90](https://github.com/opendistro-for-elasticsearch/alerting/pull/90))
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
## 2019-11-14, Version 1.3.0.0

### Bug Fixes
* Fixes allowing interval to be set with 0 or negative values ([#92](https://github.com/opendistro-for-elasticsearch/alerting/pull/92))
* Cleanup ElasticThreadContextElement ([#95](https://github.com/opendistro-for-elasticsearch/alerting/pull/95))
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
## 2020-02-07, Version 1.4.0.0

### Features
* Adds settings to disable alert history and delete old history indices ([#143](https://github.com/opendistro-for-elasticsearch/alerting/pull/143))
* Adds maven publish task for notification subproject for other plugins to utilize ([#97](https://github.com/opendistro-for-elasticsearch/alerting/pull/97))

### Bug Fixes
* Removes unsupported HttpInput types which was breaking Alerting Kibana ([#162](https://github.com/opendistro-for-elasticsearch/alerting/pull/162))
* Fixes missing constructors for Stats when updating to 7.4.2 ([#142](https://github.com/opendistro-for-elasticsearch/alerting/pull/142))
* Fixes multi node alerting stats API ([#128](https://github.com/opendistro-for-elasticsearch/alerting/pull/128))

### Maintenance
* Adds support for Elasticsearch 7.4.2 ([#141](https://github.com/opendistro-for-elasticsearch/alerting/pull/141))
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
## 2020-04-03, Version 1.6.0.0

### Infrastructure
* Add release workflow ([#180](https://github.com/opendistro-for-elasticsearch/alerting/pull/180))
* Update 'checkout' action in test-workflow.yml ([#183](https://github.com/opendistro-for-elasticsearch/alerting/pull/183))
* Add workflow - Push Notification Jar to Maven ([#174](https://github.com/opendistro-for-elasticsearch/alerting/pull/174))
* Updates java version in push notification workflow ([#187](https://github.com/opendistro-for-elasticsearch/alerting/pull/187))

### Maintenance
* Adds support for Elasticsearch 7.6.1 ([#186](https://github.com/opendistro-for-elasticsearch/alerting/pull/186))
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
## 2020-05-19, Version 1.8.0.0

### Maintenance
* Adds support for Elasticsearch 7.7.0 ([#205](https://github.com/opendistro-for-elasticsearch/alerting/pull/205))
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
## 2020-06-24, Version 1.9.0.0

### Breaking Changes
* Change default value of the index rollover condition ([#206](https://github.com/opendistro-for-elasticsearch/alerting/pull/206))

### Maintenance
* Adds support for Elasticsearch 7.8.0 ([#219](https://github.com/opendistro-for-elasticsearch/alerting/pull/219))

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

0 comments on commit 91f0650

Please sign in to comment.