kartoza / prj.app

A django app for creating visual changelogs for software releases
30 stars 32 forks source link

We need to implement support for adding entries via github hooks #146

Open timlinux opened 8 years ago

timlinux commented 8 years ago

See https://github.com/mbernasocchi/experiments/tree/master/githooks

The idea is whenever someone makes a commit with the word [FEATURE] in it, we automatically create an entry for the changelog.

timlinux commented 8 years ago

See rather this script:

https://github.com/qgis/QGIS-Sysadmin/blob/master/webhooks/github_feature_tracker.cgi

timlinux commented 8 years ago

We also should make a similar one that gets deprecated api notes and adds it to a developer section. See chat transcript below:

m-kuhn 13:50
did you set up this great infrastructure to create issues when new [feature]s are added?

rduivenvoorde 13:50
uh...
yes, why

m-kuhn 13:50
it's cool
and I'd have a small proposal to make it even better

rduivenvoorde 13:51
but... /me worried what is coming..
ah
yes 

m-kuhn 13:51
would be cool to grep for @deprecated in the change and also open an issue to document api changes
@mbernasocchi already did some research

rduivenvoorde 13:52
https://github.com/qgis/QGIS-Sysadmin/blob/master/webhooks/github_feature_tracker.cgi

m-kuhn 13:52
listen to https://developer.github.com/v3/activity/events/types/#pushevent
from the payload:
url = payload["commits"]["head_commit"]["url"]
diff_url = url + '.diff'
grep deprecated in diff_url content

timlinux 13:52
@m-kuhn thats a cool idea
we are planning to set up auto-adding of entries to the visual changelog too
It would be cool to have a deprecated section

rduivenvoorde 13:54
@m-kuhn just add an issue to the QGIS-Sysadmin with enough info in it

m-kuhn 13:54
That would be really cool, there should be a user targetted "visual" section and a developer targetted release notes section

rduivenvoorde 13:54
or do a pull request if in a hurry

m-kuhn 13:54
It would be even cooler if we could automatically extract the content of the @deprecated doxygen tag, I normally put instructions how to update the code directly there

timlinux 13:55
Seems like the QGIS hook has a red flag?

rduivenvoorde 13:57
mmm

CC

@m-kuhn @rduivenvoorde

timlinux commented 8 years ago

See also qgis/QGIS-Sysadmin#3

timlinux commented 8 years ago

I'd like to bump this up the priority list as it is a fundamental part of making the changelog easy to construct. We can let the user specify a tag to look for e.g. [FEATURE] in the commit message that determine if the entry gets created. We should chat about the behaviour a bit, but I think there should be a holding area for pending entries that have no version associated with them yet, or we should automatically make a new entry if there is not one who's release date is not yet passed...

timlinux commented 8 years ago

The commit message body should become the entry message body - any maybe we can even fish out any screenshots referenced in the message?

Also we should make the hook work with PR's probably rather than commit messages...

timlinux commented 6 years ago

@ismailsunni will you take on this task? It needs to be linked to the project model so there can be a separate hook per project....