{"repo":"nytimes/Chronicler","free":true,"listed":false,"github":"https://github.com/nytimes/Chronicler","clone":"git clone https://github.com/nytimes/Chronicler.git","description":"A better way to write your release notes.","language":"JavaScript","stars":162,"topics":["nodejs","github-api","webhooks-api","release-notes","automation"],"license":"Apache-2.0","category":"workflow-automation","readme_excerpt":"Chronicler Chronicler is an open source node.js app that automates your repo's release notes. Chronicler will listen for pull request events from GitHub Webhooks. When a pull request is merged Chronicler will create a new release draft OR edit an existing one with the PR info. The result is a neatly formatted release note draft listing all PRs merged since your last tagged release. Read more in the Times Open blog post. How it Works Chronicler receives GitHub Webhook events from the repository you hook it up to. By listening for pull request events, Chronicler can watch for merged PRs and add them to release note drafts. When a PR is merged Chronicler will either create a new release draft or edit an existing draft. If a note draft does not already exist a new, untagged draft will be created titled NEXT RELEASE with the PR info as the body content. If a draft does exist it will append the PR to it. The draft body consists of a list of pull requests with the PR title and number: Pull Request format Draft Example Getting Started Chronicler is a simple express.js app that receives GitHub Webhook events via its /webhooks route. You'll need to clone and set the app up on a server or cloud service (e.x. Google Cloud Platform, AWS, Digital Ocean) to use it for your own projects. Setup Environment Variables The following variables must be set up and available to Chronicler via the node.js process.env object. Variable Name Description Default --- --- :---: GH TOKEN The Github personal","default_branch":null,"files":null,"tree":[],"storefront":"/r/nytimes","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/nytimes/Chronicler/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}