Skip to content

Commit 3108308

Browse files
Merge pull request #3125 from jasongrout/changelog8
Checking milestone and generating changelog
2 parents a202a61 + 7264bd2 commit 3108308

File tree

2 files changed

+24
-0
lines changed

2 files changed

+24
-0
lines changed

docs/source/dev_release.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,16 @@ Update conda-forge packages (if the requirements changed to ipywidgets, make sur
125125
Release Notes
126126
=============
127127

128+
### Changelog
129+
130+
- 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
131+
- Write release highlights. You can use the list generated below as a starting point:
132+
```bash
133+
loghub jupyter-widgets/ipywidgets -m XXX -t $GITHUB_TOKEN --template scripts/release_template.txt
134+
```
135+
136+
### Example
137+
128138
Here is an example of the release statistics for ipywidgets 7.0.
129139

130140
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.

scripts/release_template.txt

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
### [v{{ version }}](https://github.com/jupyter-widgets/ipywidgets/releases/tag/v{{ version }}) ({{ close_date }})
2+
3+
See the [ipywidgets
4+
{{ version }}](https://github.com/jupyter-widgets/ipywidgets/milestone/XXXX?closed=1)
5+
milestone on GitHub for the full list of pull requests and issues closed.
6+
7+
{% for pr in pull_requests -%}
8+
* {{ pr['title'] | capitalize }} ([#{{ pr['number'] }}]({{pr['html_url']}})
9+
{%- if pr['loghub_related_issues']|length %}
10+
{%- for pri in pr['loghub_related_issues'] -%}
11+
, [#{{ pri['text'] }}]({{ pri['url'] }})
12+
{%- endfor -%}
13+
{%- endif %})
14+
{% endfor %}

0 commit comments

Comments
 (0)