bowie

README

bowie

A pretty changelog generator

Built with ❤ by @mattstratton in Go.

Time may change me
But I can't trace time
-- David Bowie

Inspired by skywinder/github-changelog-generator.

This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. We appreciate your contribution. Please refer to the contributing guidelines for details on how to help.

• Installation
  • Go
  • Homebrew
  • Yum
  • Apt
  • Chocolatey
• Usage
  • GitHub token
• Contributing
• Versioning
• Authors
• Acknowledgments
• License

Installation

You can install bowie in multiple ways.

Go

go get github.com/mattstratton/bowie

Homebrew

brew install mattstratton/tap/bowie

Yum

yum install ... TODO: Not yet available

Apt

apt-get ... TODO: Not yet available

Chocolatey

choco ... TODO: Not yet available

Usage

bowie -u [username] -p [projectname]

Where [username] is your GitHub user or organization (i.e., "mattstratton" or "google"), and [projectname] is the name of the GitHub project (i.e., "bowie").

If you doing specify a user and org, it will try to infer it based upon the git remote set as origin TODO: This doesn't work yet.

There will be other flags later. Also, remember to set the environment variable BOWIE_GITHUB_TOKEN or use the -t flag to pass it at the command line (TODO: add details on the token)

GitHub token

bowie requires a GitHub token to function.

Follow these steps:

• Generate a token here - you only need "repo" scope for private repositories
• Either:
  • Run the script with --token <your-40-digit-token>; OR
  • Set the BOWIE_GITHUB_TOKEN environment variable to your 40 digit token

You can set an environment variable by running the following command at the prompt, or by adding it to your shell profile (e.g., ~/.bash_profile or ~/.zshrc):

export BOWIE_GITHUB_TOKEN="«your-40-digit-github-token»"

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Matt Stratton - Initial work - mattstratton

Acknowledgments

• skywinder/github-changelog-generator
• goreleaser/goreleaser
• spf13/cobra
• Logo via David Bowie by James Fenton from the Noun Project

License

bowie - A pretty changelog generator

Author:	Matt Stratton (matt.stratton@gmail.com)
Copyright:	Copyright 2017, Matt Stratton
License:	The MIT License

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Documentation

Overview

A pretty changelog generator