/releases-builder

Builds release notes from GitHub issues

Primary LanguageRuby

Releases Builder

This script will create a Jekyll post from the body of an issue.

The script has an endpoint triggered by GitHub issue webhook:

$ curl -X POST https://bebanjo-releases-builder.herokuapp.com/ping

The issue must also have the tag column:release and frontmatter like this:

---
title: Title of the release note
date: YYYY-MM-DD HH:MM:SS
updated: YYYY-MM-DD HH:MM:SS
revision: 1
---

Description of the release note.

## References

- `repo#number` Title of the referenced issue

Install

  1. git clone git@github.com:bebanjo/releases-builder.git and cd releases-builder
  2. cp .env-sample .env, edit and get a personal token (repo access)
  3. Install dependencies with bundle install
  4. Run the application with foreman start web e.g. -> https://bebanjo-releases-builder.herokuapp.com
  5. The repo you want to create releases needs a webhook e.g. https://github.com/<user>/<repo>/settings/hooks
  6. Point the webhook to your ping URL e.g. https://bebanjo-releases-builder.herokuapp.com/ping
  7. Now when you create a repo with frontmatter and add the tag, releases builder will create a PR

Release

At the moment, the code is setup in a Heroku account (tech_admin@bebanjo.com user). In order to release a new version of the code, you just need to push your changes to the stable branch in Github, and Heroku will automatically deploy the changes.