search

github-tools / github-release-notes

Node module to create a release or a changelog from a tag and uses issues or commits to creating the release notes.
https://github-tools.github.io/github-release-notes/
GNU General Public License v3.0
880 stars 325 forks source link

How to use gren for private repo and django/react app? #193

Open simkimsia opened 5 years ago

simkimsia commented 5 years ago

I have a private repo in Github which uses django for backend and react for frontend

I like to have my changelog exposed to my endusers as well.

If I expose my changelog to endusers AND I use gren, this will certainly force me and my team to write better commit messages.

I typically handwrite the changelog into html markup for the changelog to show up in the app. And typically it's just a long html page with the contents arranged like this:

v0.11.0 (yyyy-mm-dd)

- something 
- another thing

v0.10.2 (yyyy-mm-dd)

- something
- another thing

and so on...

What's the output of running gren so that I can transpile it into the format I need to show to endusers?

alexcanessa commented 5 years ago

Hello! 👋

First thing: you don't necessarily need commits to generate release notes. You can also use issues or prs. (see more docs here)

The output is in markdown, so you'd need something to transpile it after (there are many md -> html packages, even runtime).