Skip to content

Commit

Permalink
Merge pull request jupyter-widgets#3125 from jasongrout/changelog8
Browse files Browse the repository at this point in the history
Checking milestone and generating changelog
  • Loading branch information
SylvainCorlay authored Feb 18, 2021
2 parents a202a61 + 7264bd2 commit 3108308
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 0 deletions.
10 changes: 10 additions & 0 deletions docs/source/dev_release.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
14 changes: 14 additions & 0 deletions scripts/release_template.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
### [v{{ version }}](https://github.com/jupyter-widgets/ipywidgets/releases/tag/v{{ version }}) ({{ close_date }})

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']}})
{%- if pr['loghub_related_issues']|length %}
{%- for pri in pr['loghub_related_issues'] -%}
, [#{{ pri['text'] }}]({{ pri['url'] }})
{%- endfor -%}
{%- endif %})
{% endfor %}

0 comments on commit 3108308

Please sign in to comment.