alexdresko / HSPI

HomeSeer plugin helper framework
MIT License
11 stars 11 forks source link

Automate the changelog #75

Open alexdresko opened 7 years ago

alexdresko commented 7 years ago

Summary

In a recent post on the blog, I mentioned an unanswered question about how to handle the change log. I just stumbled across some possible solutions while doing something for work.

Expected Behavior

The change log and git release notes should be automatically generated based on the Github issues.

Current Behavior

We have no standard. No plan. No decision has been made.

Possible Solution

The following links may prove helpful:

change log github issues - Google Search https://www.google.com/search?q=change+log+github+issues&oq=change+log+github+issues&aqs=chrome..69i57j0.3019j0j1&sourceid=chrome&ie=UTF-8

skywinder/github-changelog-generator: Automatically generate change log from your tags, issues, labels and pull requests on GitHub. https://github.com/skywinder/github-changelog-generator

Github-changelog-generator by skywinder https://skywinder.github.io/github-changelog-generator/#output-example

Why not use GitHub release notes? · Issue #1 · olivierlacan/keep-a-changelog https://github.com/olivierlacan/keep-a-changelog/issues/1

Steps to Reproduce (for bugs)

  1. Make some changes to the codebase
  2. Release a new version. What's that process again? Oh, right, we don't have one.

Context

Automate everything, forever.

alexcanessa commented 7 years ago

@alexdresko I was reading out your issue and I think the npm package ⚡️🤖 gren might suit you.

Generates release notes for the tags and generates Github releases. All is based on issues which you can also link to milestones.

If you want I could help to set it up.