GitPlanet

Cheap and reliable Node.js hosting starts at $3/month, and $1/month static HTML hosting

Created with love in Canada, visit hostnodejs.com today

Feel like to post an Ad? Learn Details
All Projects → ldez → gcg

ldez / gcg

Licence: Apache-2.0 license
GCG is a GitHub Changelog Generator.

Programming Languages

go
31211 projects - #10 most used programming language
Makefile
30231 projects

Labels

githubgeneratorchangelog

Projects that are alternatives of or similar to gcg

Changelog
📘 semantic-release plugin to create or update a changelog file
Stars: ✭ 142 (+992.31%)
Mutual labels:  changelog
Gem updater
Update gems in your Gemfile and fetch their changelogs
Stars: ✭ 206 (+1484.62%)
Mutual labels:  changelog
git-changelog
Categorized change logs from git messages
Stars: ✭ 20 (+53.85%)
Mutual labels:  changelog
Loglive
Render changelog as a website on the fly.
Stars: ✭ 146 (+1023.08%)
Mutual labels:  changelog
Fastlane Plugin Changelog
Automate changes to your project CHANGELOG.md
Stars: ✭ 176 (+1253.85%)
Mutual labels:  changelog
Gitmoji Changelog
A changelog generator for gitmoji 😜
Stars: ✭ 250 (+1823.08%)
Mutual labels:  changelog
Appupdater
A library that checks for your apps' updates on Google Play, GitHub, Amazon, F-Droid or your own server. API 9+ required.
Stars: ✭ 1,793 (+13692.31%)
Mutual labels:  changelog
next-release
Next Release is a release note management platform that automates your release notes in 3 clicks.
Stars: ✭ 18 (+38.46%)
Mutual labels:  changelog
Ckchangelog
ckChangeLog - An Android Library to display a Change Log
Stars: ✭ 180 (+1284.62%)
Mutual labels:  changelog
release-changelog-builder-action
A GitHub action that builds your release notes / changelog fast, easy and exactly the way you want.
Stars: ✭ 515 (+3861.54%)
Mutual labels:  changelog
Maintainer
👨‍💻 🐳 Generate personal daily reports or summary, AUTHORS, CONTRIBUTING, CHANGELOG and so on for GitHub user or repository.
Stars: ✭ 152 (+1069.23%)
Mutual labels:  changelog
Semantic Release
📦🚀 Fully automated version management and package publishing
Stars: ✭ 14,364 (+110392.31%)
Mutual labels:  changelog
yaclt
Yet Another Change Log Tool
Stars: ✭ 24 (+84.62%)
Mutual labels:  changelog
Commit Analyzer
💡 semantic-release plugin to analyze commits with conventional-changelog
Stars: ✭ 146 (+1023.08%)
Mutual labels:  changelog
attribution
Generate changelogs from commit tags and shortlogs
Stars: ✭ 20 (+53.85%)
Mutual labels:  changelog
Gacp
💬Git add, commit, push with Conventional Commits and Gitmoji.
Stars: ✭ 139 (+969.23%)
Mutual labels:  changelog
Npm Upgrade
Interactive CLI utility to easily update outdated NPM dependencies
Stars: ✭ 245 (+1784.62%)
Mutual labels:  changelog
kacl
Keep a Changelog tooling for automating changelog releases
Stars: ✭ 12 (-7.69%)
Mutual labels:  changelog
git
🔀 semantic-release plugin to commit release assets to the project's git repository
Stars: ✭ 235 (+1707.69%)
Mutual labels:  changelog
hubkit
Project maintainance tool for GitHub repositories
Stars: ✭ 27 (+107.69%)
Mutual labels:  changelog
View All Similar Projects ➔

GCG - GitHub Changelog Generator

release Build Status Go Report Card Sponsor

GCG 
GCG is a GitHub Changelog Generator.
The generator use only Pull Requests.

Usage: gcg [flags] <command> [<arguments>]

Use "gcg <command> --help" for help on any command.

Commands:
        version                                            Display the version.

Flag's usage: gcg [--flag=flag_argument] [-f[flag_argument]] ...     set flag_argument to flag(s)
          or: gcg [--flag[=true|false| ]] [-f[true|false| ]] ...     set true/false to boolean flag(s)

Flags:
-b, --base-branch               Base branch name. PR branch destination.                  (default "master")
    --bug-label                 Bug Label.                                                (default "bug")
    --config-file               A configuration file. [optional]
-c, --current-ref               Current commit reference. Can be a tag, a branch, a SHA.
    --debug                     Debug mode.                                               (default "false")
    --display-label             Display labels                                            (default "true")
    --dl-options                Label display options.                                    (default "true")
    --dl-options.prefix-exclude Excluded label prefixes.
    --dl-options.prefix-filter  Included label prefixes.
    --dl-options.prefix-trim    Trim label with the following prefixes.
    --dl-options.suffix-exclude Excluded label suffixes.
    --dl-options.suffix-filter  Included label suffixes.
    --doc-label                 Documentation Label.                                      (default "documentation")
    --enhancement-label         Enhancement Label.                                        (default "enhancement")
    --exclude-label             Label to exclude.
    --file-name                 Name of the changelog file.                               (default "CHANGELOG.md")
-f, --future-ref-name           The future name of the current reference.
    --output-type               Output destination type. (file|Stdout)                    (default "file")
-o, --owner                     Repository owner.
-p, --previous-ref              Previous commit reference. Can be a tag, a branch, a SHA.
-r, --repo-name                 Repository name.
    --th-after                  Threshold in seconds after the current ref date.          (default "5")
    --th-before                 Threshold in seconds after the previous ref date.         (default "1")
    --tmpl-file                 A template file. [optional]
-t, --token                     GitHub Token. [optional]
-h, --help                      Print Help (this message) and exit

How to Install

OS Command

Linux

ArchLinux (AUR)

 
yay -S gcg

MacOS

Homebrew Taps

 
brew tap ldez/tap
brew update
brew install gcg

Windows

Scoop Bucket

 
scoop bucket add ldez https://github.com/ldez/scoop-bucket.git
scoop install gcg

all

Binaries

  • To get the binary just download the latest release for your OS/Arch from the releases page

  • Unzip the archive.

  • Add gcg in your PATH.

all

Sources

 
go get -u github.com/ldez/gcg

Examples

gcg -p"v1.2.0-rc1" -c"v1.3.0-rc1" -o"containous" -r"traefik" -t"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Next major release (RC1 on master)

ex: for the (non-existing) next version 1.4.0-rc1

case 01 
gcg -b"master" -p"v1.3.0-rc1" -c"master" -f"v1.4.0-rc1" \
-o"containous" -r"traefik" -t"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
--exclude-label="area/infrastructure" \
--enhancement-label="kind/enhancement" --doc-label="area/documentation" --bug-label="kind/bug/fix" \
--debug

Next RC release (RC2 on a specific branch)

ex: for the (non-existing) version 1.3.0-rc2

case 02 
gcg -b"v1.3" -p"v1.3.0-rc1" -c"v1.3" -f"v1.3.0-rc2" \
-o"containous" -r"traefik" \
--exclude-label="area/infrastructure" \
--enhancement-label="kind/enhancement" --doc-label="area/documentation" --bug-label="kind/bug/fix" \
--debug

Previous major release (Pre RC1)

ex: for the (existing) version 1.3.0-rc1

case 03 
gcg -b"master" -p"v1.2.0-rc1" -c"v1.3.0-rc1" \
-o"containous" -r"traefik" \
--exclude-label="area/infrastructure" \
--enhancement-label="kind/enhancement" --doc-label="area/documentation" --bug-label="kind/bug/fix" \
--debug

Previous RC release (between RC1 and RC2)

ex: for the (existing) version 1.3.0-rc2

case 04 
gcg -b"v1.3" -p"v1.3.0-rc1" -c"v1.3.0-rc2" \
-o"containous" -r"traefik" \
--exclude-label="area/infrastructure" \
--enhancement-label="kind/enhancement" --doc-label="area/documentation" --bug-label="kind/bug/fix" \
--debug

Filtered Labels

gcg -b"v1.3" -p"v1.3.0-rc1" -c"v1.3" -f"v1.3.0"  \
-o"containous" -r"traefik" \
--exclude-label="area/infrastructure" \
--enhancement-label="kind/enhancement" --doc-label="area/documentation" --bug-label="kind/bug/fix" \
--dl-options.prefix-filter="area/,platform/" \
--dl-options.suffix-exclude="documentation" \
--dl-options.prefix-trim="area/provider/,area/middleware/,area/,platform/" \
--debug
gcg \
--base-branch="v1.3" --previous-ref="v1.3.0-rc1" \
--current-ref="v1.3" --future-ref-name="v1.3.0" \
--owner="containous" --repo-name="traefik" \
--exclude-label="area/infrastructure" \
--enhancement-label="kind/enhancement" --doc-label="area/documentation" --bug-label="kind/bug/fix" \
--dl-options.prefix-filter="area/,platform/" \
--dl-options.suffix-exclude="documentation" \
--dl-options.prefix-trim="area/provider/,area/middleware/,area/,platform/" \
--debug

References

Images generated with gitgraphjs

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].