From 50e2b326880a26ffaff78dc78980d17ca28a2654 Mon Sep 17 00:00:00 2001 From: Jason Grout Date: Wed, 17 Feb 2021 00:02:27 -0800 Subject: [PATCH 1/2] Add brief, rough instructions for checking the PR milestones and generating a list of PRs for release notes. --- docs/source/dev_release.md | 10 ++++++++++ scripts/release_template.txt | 18 ++++++++++++++++++ 2 files changed, 28 insertions(+) create mode 100644 scripts/release_template.txt diff --git a/docs/source/dev_release.md b/docs/source/dev_release.md index 1b9d3a1ec1..2703f305c4 100644 --- a/docs/source/dev_release.md +++ b/docs/source/dev_release.md @@ -125,6 +125,16 @@ Update conda-forge packages (if the requirements changed to ipywidgets, make sur Release Notes ============= +### Changelog + +- Modify `scripts/milestone_check.py` to include the release and commit range for the release, and run `python scripts/milestone_check.py` to check the issues assigned to this milestone +- Write release highlights. You can use the list generated below as a starting point: + ```bash + loghub jupyter-widgets/ipywidgets -m XXX -t $GITHUB_TOKEN --template scripts/release_template.txt + ``` + +### Example + Here is an example of the release statistics for ipywidgets 7.0. It has been 157 days since the last release. In this release, we closed [127 issues](https://github.com/jupyter-widgets/ipywidgets/issues?q=is%3Aissue+is%3Aclosed+milestone%3A7.0) and [216 pull requests](https://github.com/jupyter-widgets/ipywidgets/pulls?q=is%3Apr+milestone%3A7.0+is%3Aclosed) with [1069](https://github.com/jupyter-widgets/ipywidgets/compare/6.0.0...7.0.0) commits, of which 851 are not merges. diff --git a/scripts/release_template.txt b/scripts/release_template.txt new file mode 100644 index 0000000000..e8f8884c98 --- /dev/null +++ b/scripts/release_template.txt @@ -0,0 +1,18 @@ +`v{{ version }} `__ +--------------------------------------------------------------------------- + +{{ close_date }} +^^^^^^^^^^^^^^^ + +See the `ipywidgets +{{ version }} `__ +milestone on GitHub for the full list of pull requests and issues closed. + +{% for pr in pull_requests -%} +* {{ pr['title'] | capitalize }} (`#{{ pr['number'] }} <{{pr['html_url']}}>`__ +{%- if pr['loghub_related_issues']|length %} +{%- for pri in pr['loghub_related_issues'] -%} + , `#{{ pri['text'] }} <{{ pri['url'] }}>`__ +{%- endfor -%} +{%- endif %}) +{% endfor %} From 7264bd2de1f238c6eff0319bbad60b7ef9a70cd3 Mon Sep 17 00:00:00 2001 From: Jason Grout Date: Wed, 17 Feb 2021 00:19:53 -0800 Subject: [PATCH 2/2] Update release_template.txt to be markdown --- scripts/release_template.txt | 14 +++++--------- 1 file changed, 5 insertions(+), 9 deletions(-) diff --git a/scripts/release_template.txt b/scripts/release_template.txt index e8f8884c98..5f21f8e1fa 100644 --- a/scripts/release_template.txt +++ b/scripts/release_template.txt @@ -1,18 +1,14 @@ -`v{{ version }} `__ ---------------------------------------------------------------------------- +### [v{{ version }}](https://github.com/jupyter-widgets/ipywidgets/releases/tag/v{{ version }}) ({{ close_date }}) -{{ close_date }} -^^^^^^^^^^^^^^^ - -See the `ipywidgets -{{ version }} `__ +See the [ipywidgets +{{ version }}](https://github.com/jupyter-widgets/ipywidgets/milestone/XXXX?closed=1) milestone on GitHub for the full list of pull requests and issues closed. {% for pr in pull_requests -%} -* {{ pr['title'] | capitalize }} (`#{{ pr['number'] }} <{{pr['html_url']}}>`__ +* {{ pr['title'] | capitalize }} ([#{{ pr['number'] }}]({{pr['html_url']}}) {%- if pr['loghub_related_issues']|length %} {%- for pri in pr['loghub_related_issues'] -%} - , `#{{ pri['text'] }} <{{ pri['url'] }}>`__ + , [#{{ pri['text'] }}]({{ pri['url'] }}) {%- endfor -%} {%- endif %}) {% endfor %}