Skip to content
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

Changelog generator for Piwik that will credit people who participated in the release #5380

Closed
mattab opened this issue Jun 25, 2014 · 3 comments
Assignees
Labels
c: Website matomo.org For issues related to our matomo.org website. Major Indicates the severity or impact or benefit of an issue is much higher than normal but not critical. Task Indicates an issue is neither a feature nor a bug and it's purely a "technical" change.
Milestone

Comments

@mattab
Copy link
Member

mattab commented Jun 25, 2014

Publishing a good changelog is very important for an open source project like Piwik. You can find online our changelogs for our past 64 releases. As long as we've been using trac, when writing the changelog, I've been using this page to generate the list of tickets closed since last release.

Now that we are migrating to use Github issues in #5273 (NICE!) we can use this opportunity to generate an even better changelog for Piwik releases.

The goals of this ticket are:

  • let Piwik release manager easily generate changelog
  • better credit all humans who have participated in Piwik issues and release (by quoting their name and linking to github profiles)

Proposal

  • Create a web page
  • Input: a datetime
  • Output:
    • a list of issues that were closed since this date time
    • for each issue, display:
    • the issue #number
    • the issue name
    • the list of people who have contributed code in this issue

For example a changelog entry for an issue would look like:

 #1486 New plugin: define Custom Alerts and receive email when triggered [@tsteur and @mattab](by) ```

**How it will be used?**

When generating a new release, Piwik release manager will go to this page, input the date, and then will copy paste the generated changelog in the blog post to be published ([such as this one](https://piwik.org/changelog/piwik-2-3-0/)). 

Do you have some thoughts? 
@mattab mattab added this to the 2.5.0 - Piwik 2.5.0 milestone Jul 8, 2014
@tsteur
Copy link
Member

tsteur commented Jul 9, 2014

Published a first version here: https://github.com/piwik/github-changelog-generator

It runs entirely in the browser! It's a bit hard to test right after the migration from Trac so there might be some issues. It detects people who have contributed code but cannot guarantee it works for 100%. We'll have to see!

@tsteur tsteur self-assigned this Jul 9, 2014
@mattab
Copy link
Member Author

mattab commented Jul 9, 2014

I've tested it quickly to try generate changelog for 2.4.1. Nice!

Feedback:

  • we need as well a list of labels that when the ticket has any of these label then it will not show in the changelog. For example for piwik/piwik repository such labels would be R: wontfix and R: duplicate R: answered and R: invalid.

tsteur added a commit to matomo-org/github-changelog-generator that referenced this issue Jul 9, 2014
tsteur added a commit to matomo-org/github-changelog-generator that referenced this issue Jul 9, 2014
@mattab
Copy link
Member Author

mattab commented Jul 11, 2014

Nice work. Maybe we can write blog post about this open source project. Let's discuss in Munich!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c: Website matomo.org For issues related to our matomo.org website. Major Indicates the severity or impact or benefit of an issue is much higher than normal but not critical. Task Indicates an issue is neither a feature nor a bug and it's purely a "technical" change.
Projects
None yet
Development

No branches or pull requests

2 participants