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

Automatically generate the changelog #759

Closed
kostko opened this issue Aug 6, 2018 · 6 comments · Fixed by #2496
Closed

Automatically generate the changelog #759

kostko opened this issue Aug 6, 2018 · 6 comments · Fixed by #2496
Assignees
Labels
c:docs Category: documentation p:1 Priority: core feature

Comments

@kostko
Copy link
Member

kostko commented Aug 6, 2018

We should consider automatically generating the changelog.

@kostko kostko added s:good first issue Status: good for newcomers p:3 Priority: nice to have c:docs Category: documentation labels Aug 6, 2018
@nhynes
Copy link
Contributor

nhynes commented Aug 6, 2018

@ryscheng-mobile ryscheng-mobile added p:2 Priority: desired feature p:1 Priority: core feature and removed p:3 Priority: nice to have p:2 Priority: desired feature labels Oct 24, 2018
@ryscheng-mobile
Copy link
Contributor

Our changelog hasnt been updated in months. Seems like this is going to be more relevant post public testnet as we do regular release announcements

@kostko
Copy link
Member Author

kostko commented Oct 25, 2018

Are we planning to make the ekiden repository public once we do a public testnet?

@willscott
Copy link
Contributor

I would guess we won't be there 'at public testnet', but that'll be next next milestone on the way to mainnet

@nhynes
Copy link
Contributor

nhynes commented Nov 26, 2018

Another tool https://github.com/NYTimes/Chronicler

@tjanez
Copy link
Member

tjanez commented Dec 9, 2019

Implementation proposal

Each pull request that is made to the Oasis Core repo should generally include a Changelog fragment in the newsfragments/ directory.

Before a release, all news fragments are automatically assembled into the Changelog file using the towncrier utility and committed into the repo.

Examples of news fragments of (some) popular projects using towncrier:

Although it is geared towards Python projects and works with rST by default, it can be made to work with Markdown and for non-Python projects.

@kostko kostko changed the title Consider automatically generating the changelog Automatically generate the changelog Dec 9, 2019
@kostko kostko removed the s:good first issue Status: good for newcomers label Dec 9, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c:docs Category: documentation p:1 Priority: core feature
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants