Skip to content

Github powered release notes one pager for stakeholders.

Notifications You must be signed in to change notification settings

mathiasjakobsen/release-notes

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Release Notes

Release notes service to proxy Github release notes directly into an embedable release notes log, for product users. The service will query Github, at runtime, for the latest 100 releases and display them as a nice one pager of markdown release notes.

Example

The release notes for this repository, will look like this.

Cool cool cool cool..

Prerequisites

The service requires three enviroment variables, at runtime:

  • BEARER - Github personal token, with repo:read permissions
  • OWNER- Github organization name
  • TOKENS- Comma (,) separated list of custom tokens, used for embedding the one page into your app- or website

How to Use

Install dependecies:

bundle install

Run the service by:

rackup config.ru

Open:

http://localhost:9292/:repo?bearer=:token