gdp

command module
v0.2.7 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 27, 2022 License: MIT Imports: 14 Imported by: 0

README

gdp

gdp is a CLI tool for pushing the tag associated with deployment and publishing the release note in GitHub.

GitHub go.mod Go version Build Status Go Report Card GoDoc Latest Version License

Requirements

Installation

Via Homebrew
$ brew tap Connehito/gdp
$ brew install gdp
Via go install
$ go install github.com/Connehito/gdp@latest

Usage

Deploy

Add the tag to local repository and push the tag to remote(origin) repository.

# specify tag
$ gdp deploy -t TAG

# dry-run
$ gdp deploy -t TAG -d

# force(skipped validation)
$ gdp deploy -t TAG -f

# set tag automatically
$ gdp deploy
Publish

Create the release note in GitHub which based on the merge commits of the tag.

# specify tag
$ gdp publish -t TAG

# dry-run
$ gdp publish -t TAG -d

# force(skipped validation)
$ gdp publish -t TAG -f

# set tag automatically
$ gdp publish

Specification

Supported tag's format
  • semantic version: e.g. v1.2.3 or 1.2.3
  • date version: e.g. 20180525.1 or release_20180525
How to create generate note

Release note content is generated based on merge commit messages.

So, depending on your branch strategy, it may not be the intended result.

What is last printed message?

When gdp succeeds, the following message is printed.

Do not be satisfied with 'released', let's face user's feedback in sincerity!

This is the watchword of Connehito's developers.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/Connehito/gdp.

License

gdp is available as open source under the terms of the MIT License.

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL