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

Generate a Changelog file #740

Open
honzajavorek opened this Issue Mar 5, 2017 · 1 comment

Comments

Projects
None yet
1 participant
@honzajavorek
Copy link
Member

honzajavorek commented Mar 5, 2017

As of now, we use Semantic Release to generate changelog to GitHub Releases. I'd like to have a tool, which serializes GitHub Releases to a single Markdown/reStructuredText file, so it could become a part of generated documentation. Why?

  1. Backup of the changelog (file versus GitHub SaaS)
  2. Sometimes when upgrading, it's easier to scan through and follow the changes if they're all listed on a single page. GitHub UI for releases is click-heavy.

The generated file wouldn't get committed to the repository, rather it would be a result of compilation of the docs.

Note: The internet is full of tools to generate GitHub Releases from something, but I'm yet to find a tool to generate a file from GitHub Releases.

Bonus: When we have this, we can generate similar files for Gavel.js and dredd-transactions.

@honzajavorek

This comment has been minimized.

Copy link
Member

honzajavorek commented Nov 24, 2018

This could be done as Sphinx extension now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment