Skip to content

Latest commit

 

History

History
63 lines (44 loc) · 2.36 KB

README.md

File metadata and controls

63 lines (44 loc) · 2.36 KB

prlog

The idea behind prlog is to join information stored in git history and GitHub's pull requests in order to create a changelog between two commits. The pull requests can be grouped by their labels to make the changelog even more readable to the users.

Installation

In order to install the application, you need to go get it:

$ go get -u github.com/slomek/prlog

$ prlog
Parameters 'repo', 'from' and 'to' are required:
-config string
        path to the config file (default "/Users/slomek/.prlog.yaml")
-from string
        first commit of the changelog
-repo string
        'organization/name' of repository
-to string
        last commit of the changelog

Usage

Configuration

First, you need to create a configuration YAML file (by default it is searched for in ${HOME}/.prlog.yaml):

git-token: YOUR-GIT-TOKEN

local-only: true # add only if you are using Go modules in your project

pr-labels:
    features: 
        - Enhancement
    fixes:
        - fix
        - Bug
    internal:
        - refactor
        - infra

Your git-token can be obtained from Github, under Settings -> Developer settings -> Personal access tokens -> Generate new token. Its scope should include repo group, nothing else is necessary. After clicking Generate token you need to save the value somewhere, or paste to the your prlog.yaml directly.

The pr-labels property works as follows: if a PR has a label Enhancement, it will be listed under a group called features in the changelog. The fixes group will contain all PRs having labels fix or bug. Any PRs that are not assigned to any of the defined groups will land in other section.

Usage

In order to print a changelog, you need to have a git history of the repository fetched on your local machine. Then, all you need to do is execute the app:

$ prlog -repo gobuffalo/buffalo -to caff091 -from ea3de19 -config prlog.yaml
Other:
- Fix Issue #751 - unknown flag: --use-model (#778)
- Running a single test fixes #769 (#772)

Fixes:
- Fix skip-yarn flag description (#776)
- Fix test render packr config (#770)
- Fix #767: CSRF middleware should accept wildcard mimetype (#768)

Features:
- Implement #723 - Localized views (#771)

As you can see, the PRs have been grouped into sections.