https://github.com/15five/rocket_releaser

Python library for release notes / labeling upon deploys
https://github.com/15five/rocket_releaser

devops python release-automation release-notes

Last synced: 15 days ago
JSON representation

Python library for release notes / labeling upon deploys

• Host: GitHub
• URL: https://github.com/15five/rocket_releaser
• Owner: 15five
• License: mit
• Created: 2020-10-08T16:04:16.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2026-03-11T18:57:16.000Z (21 days ago)
• Last Synced: 2026-03-12T00:17:58.976Z (21 days ago)
• Topics: devops, python, release-automation, release-notes
• Language: Python
• Homepage:
• Size: 102 KB
• Stars: 3
• Watchers: 4
• Forks: 1
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Rocket Releaser [![CircleCI](https://circleci.com/gh/15five/rocket_releaser.svg?style=svg&circle-token=022a3a89718d088ac8a737b2d03280c4c1864ed0)](https://circleci.com/gh/15five/rocket_releaser) [![PyPI version](https://badge.fury.io/py/rocket-releaser.svg)](https://badge.fury.io/py/rocket-releaser)

Library for creating release notes based on PR descriptions for a set of git changes.

![example slack message](http://i.imgur.com/5h0qzaI.png)

## Installation:

`pip install rocket-releaser`

## Usage:

```shell

python -m rocket_releaser github_token start_sha end_sha github_org github_repo -r repo_location --vpc_name staging --env_name staging --search_branch staging --slack_webhook_key slack_key

```

This would label PR's inbetween first and second sha with "staging" and send the release notes to slack.

If you are using a personal github account the "github_org" would be your github username.

The github token must have "repo" scope access and the token's user must have write access to the repo.

You can also pass in Jira paramaters to label Jira tickets. 

`--jira_token jiraToken --jira_username bob@company.com --jira_url https://company.atlassian.net`

## PR format:

To label PR's and tickets your PR's should be formatted like so:

```

 

RELEASES

Change default avatar image #public Closes [ENG-1234]

QA

default avatar image should be a penguin [ENG-1234]

```

## FAQ:

Q: Why use this over [semantic-release](https://github.com/semantic-release/semantic-release)?

A: Semantic-release's [slack plugin](https://github.com/juliuscc/semantic-release-slack-bot) as of 05/21 does not generate an extended changelog. Semantic Release does not have a plugin for tagging github PR's or tickets either, as far as I am aware.

Q: How do I run this using Ansible?

A: See https://github.com/15five/rocket_releaser/wiki/Running-Rocket-Releaser-on-Ansible