github-tools / github-tools/github-release-notes

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

Open
#193 1 comment 0 reactions 0 assignees View on GitHub
help wanted
Dominant language
JavaScript
Stars
897
Forks
313
PR merge metrics
No merged PRs in 30d

Description

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?

Contributor guide

Open the contributing guide

Research direction

No file, test, or entry point is named. Start by checking gren's generated release-note output and its handling of private repositories; done means documenting whether that output can be transformed into the requested HTML changelog format.

Written by the indexing model from the issue text.

Assessment

Tech stack
django, javascript, react
Domain
documentation, release
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.