https://github.com/connehito/gdp
gdp is a CLI tool for pushing the tag associated with deployment and publishing the release note in GitHub.
https://github.com/connehito/gdp
cli golang golang-tools
Last synced: 6 months ago
JSON representation
gdp is a CLI tool for pushing the tag associated with deployment and publishing the release note in GitHub.
- Host: GitHub
- URL: https://github.com/connehito/gdp
- Owner: Connehito
- License: mit
- Created: 2018-08-12T15:02:18.000Z (almost 8 years ago)
- Default Branch: main
- Last Pushed: 2023-01-17T16:48:57.000Z (over 3 years ago)
- Last Synced: 2024-06-19T04:10:57.251Z (about 2 years ago)
- Topics: cli, golang, golang-tools
- Language: Go
- Homepage:
- Size: 43.9 KB
- Stars: 10
- Watchers: 28
- Forks: 3
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# gdp
gdp is a CLI tool for pushing the tag associated with deployment and publishing the release note in GitHub.
[](https://github.com/Connehito/gdp/actions/workflows/ci.yml)
[](https://goreportcard.com/report/github.com/Connehito/gdp)
[](https://godoc.org/github.com/Connehito/gdp)
[](https://github.com/Connehito/gdp/releases/latest)
[](https://raw.githubusercontent.com/Connehito/gdp/main/LICENSE)
## Requirements
- [git command](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
- [hub command](https://github.com/github/hub#installation)
## Installation
### Via Homebrew
```bash
$ brew tap Connehito/gdp
$ brew install gdp
```
### Via go install
```bash
$ go install github.com/Connehito/gdp@latest
```
## Usage
### Deploy
Add the tag to local repository and push the tag to remote(origin) repository.
```bash
# 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.
```bash
# 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](https://semver.org/): 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](https://connehito.com/).
## 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](http://opensource.org/licenses/MIT).