Skip to content

Latest commit

 

History

History
141 lines (108 loc) · 4.57 KB

README.md

File metadata and controls

141 lines (108 loc) · 4.57 KB
Raw

gh-jira-changelog

image-generator-logo.png
`gh` cli plugin to generate changelog from jira

Content

Installation

Feel free to use any of the available methods

Using gh cli, as extension

gh extension install handofgod94/gh-jira-changelog

MacOS using homebrew

brew install handofgod94/tap/gh-jira-changelog

Go Toolchain

go install github.com/handofgod94/gh-jira-changelog@v0.3.2

The go binary will be installed in $GOPATH/bin

Verify installation

$ gh-jira-changelog version

v0.4.0

Quickstart

  • Install github cli as documented here
  • Install gh extension using gh extension install handofgod94/gh-jira-changelog
  • Login to github: gh auth login
  • Login to jira: gh jira-changelog auth login
  • Open repo, for which you want to generate changelog using cd
  • Run command: gh jira-changelog generate --from="v2.18.0" --to="v2.19.0" --use_pr

Note: The auth token of jira expires every 24 hours. Relogin again to fetch info from jira

Usage

$ gh-jira-changelog --help

Most of our changelog tools solely focus on commits. While the orgs usually use jira to track issues.
When generating changelog why not combine both commits and jira issues to generate a changelog.

This can also work as a plugin for "gh" cli

Usage:
  gh-jira-changelog [command]

Available Commands:
  auth        Authenticate wit jira
  completion  Generate the autocompletion script for the specified shell
  generate    Generates changelog
  help        Help about any command
  version     Current version of generator

Flags:
  -t, --api_token string   API token for jira
  -u, --base_url string    base url where jira is hosted
      --config string      config file (default is ./.jira_changelog.yaml)
      --email_id string    email id of the user
  -h, --help               help for gh-jira-changelog
  -v, --log_level string   log level. options: debug, info, warn, error (default "error")
      --repo_url string    Repo URL. Used to generate diff url. Currently only github is supported

Use "gh-jira-changelog [command] --help" for more information about a command.

Generating Changelog

$ gh-jira-changelog generate --help

Generates changelog

Usage:
  gh-jira-changelog generate [flags]

Examples:
#using as a standalone tool
gh-jira-changelog generate \
	--base_url="<you-atlassian-url>" \
	--from="<git-ref>" \
	--to="<git-ref>" \
	--api_token="<jira-api-token>" \
	--email_id="jira-email-id"
	--repo_url="https://github.com/<org>/<repo>"

# using config file
# all the jira config such as (base_url, api_token, email_id) can be stored in a config file
gh-jira-changelog generate --config="<path-to-config-file>.yaml" --from=<git-ref> --to=<git-ref>

# using env variables
# all the jira config such as (base_url, api_token, email_id) can be provided by env variables
BASE_URL=<you-atlassian-url> API_TOKEN=<jira-api-token> gh-jira-changelog generate --from=<git-ref> --to=<git-ref>

# generating changelog between 2 git tags
gh-jira-changelog generate --config="<path-to-config-file>.yaml" --from="v0.1.0" --to="v0.2.0"


# Using it as GH plugin
# assuming jira plugin installed
gh jira-changelog generate --config="<path-to-config-file>.yaml" --from="v0.1.0" --to="v0.2.0"

# using PR titles to generate changelog
gh jira-changelog generate --config="<path-to-config-file>.yaml" --from="v0.1.0" --to="v0.2.0" --use_pr

Flags:
      --from string       Git ref to start from
  -h, --help              help for generate
      --to string         Git ref to end at (default "main")
      --use_pr            use PR titles to generate changelog. Note: only works if used as gh plugin
      --write_to string   File stream to write the changelog (default "/dev/stdout")

Global Flags:
  -t, --api_token string   API token for jira
  -u, --base_url string    base url where jira is hosted
      --config string      config file (default is ./.jira_changelog.yaml)
      --email_id string    email id of the user
  -v, --log_level string   log level. options: debug, info, warn, error (default "error")
      --repo_url string    Repo URL. Used to generate diff url. Currently only github is supported