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

release notes automation #258

Merged
merged 1 commit into from
Jul 20, 2020
Merged

release notes automation #258

merged 1 commit into from
Jul 20, 2020

Conversation

bowenlan-amzn
Copy link
Contributor

@bowenlan-amzn bowenlan-amzn commented Jul 18, 2020

Issue #, if available:

Description of changes:

  1. add a workflow to track and add merged PR to a release draft, ready to publish

    • Prerequisite: label the PR! I have already created all possible related labels
    • Common labels are: feature, enhancement, version support, bug, testing, CI/CD, Refractor, documentation
    • you can check in workflow definition about which label will be categorized into which category
  2. a python script to help generate the release notes under releases folder, use it like below:

    • copy down and save the release draft generated automatically by above workflow to some file, like note.md
    • run python create_release_notes.py, input the parameters it asks for, then you will have the formatted release notes which should be ready for your release PR

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@bowenlan-amzn bowenlan-amzn added documentation A change to update existing documentations such as README, instruction docs, etc. ci/cd labels Jul 18, 2020
@bowenlan-amzn bowenlan-amzn marked this pull request as ready for review July 18, 2020 00:47
@codecov
Copy link

codecov bot commented Jul 18, 2020

Codecov Report

Merging #258 into master will increase coverage by 0.02%.
The diff coverage is n/a.

Impacted file tree graph

@@             Coverage Diff              @@
##             master     #258      +/-   ##
============================================
+ Coverage     71.32%   71.35%   +0.02%     
+ Complexity      635      634       -1     
============================================
  Files            86       86              
  Lines          3690     3690              
  Branches        610      610              
============================================
+ Hits           2632     2633       +1     
- Misses          737      738       +1     
+ Partials        321      319       -2     
Impacted Files Coverage Δ Complexity Δ
...dexstatemanagement/elasticapi/ElasticExtensions.kt 67.34% <0.00%> (-4.09%) 0.00% <0.00%> (ø%)
...ndexstatemanagement/IndexStateManagementHistory.kt 75.72% <0.00%> (-1.95%) 27.00% <0.00%> (-1.00%)
...ticsearch/indexstatemanagement/model/Transition.kt 82.35% <0.00%> (+9.80%) 5.00% <0.00%> (ø%)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c27a763...9fa7743. Read the comment docs.

@bowenlan-amzn bowenlan-amzn requested a review from dbbaughe July 20, 2020 16:40
@bowenlan-amzn bowenlan-amzn changed the title automate release release notes automation Jul 20, 2020
Copy link

@ftianli-amzn ftianli-amzn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A big step in unifying the release notes.

@bowenlan-amzn bowenlan-amzn requested a review from qreshi July 20, 2020 16:55
@bowenlan-amzn bowenlan-amzn merged commit eef5b65 into opendistro-for-elasticsearch:master Jul 20, 2020
@bowenlan-amzn bowenlan-amzn deleted the release-note-automate branch July 20, 2020 21:51
@bowenlan-amzn
Copy link
Contributor Author

All the PRs merged after the last release will be included in the Draft release

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
ci/cd documentation A change to update existing documentations such as README, instruction docs, etc.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants