Skip to content

Checking milestone and generating changelog #3125

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 18, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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 %}