{"id":15677904,"url":"https://github.com/ldez/gcg","last_synced_at":"2025-06-28T18:09:20.765Z","repository":{"id":21194278,"uuid":"91896172","full_name":"ldez/gcg","owner":"ldez","description":"GCG is a GitHub Changelog Generator.","archived":false,"fork":false,"pushed_at":"2025-04-12T22:15:53.000Z","size":182,"stargazers_count":14,"open_issues_count":0,"forks_count":2,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-05-07T02:47:30.599Z","etag":null,"topics":["changelog","generator","github"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ldez.png","metadata":{"files":{"readme":"readme.adoc","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":"ldez","ko_fi":"ldez_oss","liberapay":"ldez","thanks_dev":"u/gh/ldez"}},"created_at":"2017-05-20T14:56:09.000Z","updated_at":"2025-04-12T22:15:56.000Z","dependencies_parsed_at":"2022-09-06T17:10:45.832Z","dependency_job_id":"48ed15e3-24ad-4188-8776-7228e12cfa58","html_url":"https://github.com/ldez/gcg","commit_stats":{"total_commits":123,"total_committers":4,"mean_commits":30.75,"dds":"0.21138211382113825","last_synced_commit":"af3d32135391c1a5235d0fbee620c1a35ab315e6"},"previous_names":[],"tags_count":22,"template":false,"template_full_name":null,"purl":"pkg:github/ldez/gcg","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ldez%2Fgcg","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ldez%2Fgcg/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ldez%2Fgcg/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ldez%2Fgcg/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ldez","download_url":"https://codeload.github.com/ldez/gcg/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ldez%2Fgcg/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262474025,"owners_count":23316908,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["changelog","generator","github"],"created_at":"2024-10-03T16:13:53.303Z","updated_at":"2025-06-28T18:09:20.744Z","avatar_url":"https://github.com/ldez.png","language":"Go","funding_links":["https://github.com/sponsors/ldez","https://ko-fi.com/ldez_oss","https://liberapay.com/ldez","https://thanks.dev/u/gh/ldez"],"categories":[],"sub_categories":[],"readme":"= GCG - GitHub Changelog Generator\n\nimage:https://img.shields.io/github/release/ldez/gcg.svg?style=flat[\"release\", link=\"https://github.com/ldez/gcg/releases\"]\nimage:https://github.com/ldez/gcg/workflows/Main/badge.svg?branch=master[\"Build Status\", link=\"https://github.com/ldez/gcg/actions\"]\nimage:https://goreportcard.com/badge/github.com/ldez/prm[\"Go Report Card\", link=\"https://goreportcard.com/report/github.com/ldez/prm\"]\nimage:https://img.shields.io/badge/Sponsor%20me-%E2%9D%A4%EF%B8%8F-pink[\"Sponsor\", link=\"https://github.com/sponsors/ldez\"]\n\nimage::https://cloud.githubusercontent.com/assets/5674651/26468714/b7a3ce64-4197-11e7-8b2e-51a13cfe504a.png[GCG]\n\n[source, yaml]\n----\nGCG is a GitHub Changelog Generator.\nThe generator use only Pull Requests.\n\nUsage: gcg [flags] \u003ccommand\u003e [\u003carguments\u003e]\n\nUse \"gcg \u003ccommand\u003e --help\" for help on any command.\n\nCommands:\n        version                                            Display the version.\n\nFlag's usage: gcg [--flag=flag_argument] [-f[flag_argument]] ...     set flag_argument to flag(s)\n          or: gcg [--flag[=true|false| ]] [-f[true|false| ]] ...     set true/false to boolean flag(s)\n\nFlags:\n-b, --base-branch               Base branch name. PR branch destination.                  (default \"master\")\n    --bug-label                 Bug Label.                                                (default \"bug\")\n    --config-file               A configuration file. [optional]\n-c, --current-ref               Current commit reference. Can be a tag, a branch, a SHA.\n    --debug                     Debug mode.                                               (default \"false\")\n    --display-label             Display labels                                            (default \"true\")\n    --dl-options                Label display options.                                    (default \"true\")\n    --dl-options.prefix-exclude Excluded label prefixes.\n    --dl-options.prefix-filter  Included label prefixes.\n    --dl-options.prefix-trim    Trim label with the following prefixes.\n    --dl-options.suffix-exclude Excluded label suffixes.\n    --dl-options.suffix-filter  Included label suffixes.\n    --doc-label                 Documentation Label.                                      (default \"documentation\")\n    --enhancement-label         Enhancement Label.                                        (default \"enhancement\")\n    --exclude-label             Label to exclude.\n    --file-name                 Name of the changelog file.                               (default \"CHANGELOG.md\")\n-f, --future-ref-name           The future name of the current reference.\n    --output-type               Output destination type. (file|Stdout)                    (default \"file\")\n-o, --owner                     Repository owner.\n-p, --previous-ref              Previous commit reference. Can be a tag, a branch, a SHA.\n-r, --repo-name                 Repository name.\n    --th-after                  Threshold in seconds after the current ref date.          (default \"5\")\n    --th-before                 Threshold in seconds after the previous ref date.         (default \"1\")\n    --tmpl-file                 A template file. [optional]\n-t, --token                     GitHub Token. [optional]\n-h, --help                      Print Help (this message) and exit\n----\n\n== How to Install\n\n|===\n| OS | | Command\n\n| Linux\n| image:https://img.shields.io/aur/version/gcg.svg?style=flat[\"ArchLinux (AUR)\", link=\"https://aur.archlinux.org/packages/gcg\"]\na|\n[source]\n----\nyay -S gcg\n----\n\n| MacOS\n| image:https://img.shields.io/github/release/ldez/gcg.svg?label=Homebrew%20Taps\u0026style=flat[\"Homebrew Taps\", link=\"https://github.com/ldez/homebrew-tap\"]\na|\n[source,bash]\n----\nbrew tap ldez/tap\nbrew update\nbrew install gcg\n----\n\n| Windows\n| image:https://img.shields.io/github/release/ldez/gcg.svg?label=Scoop%20Bucket\u0026style=flat[\"Scoop Bucket\", link=\"https://github.com/ldez/scoop-bucket\"]\na|\n[source,bash]\n----\nscoop bucket add ldez https://github.com/ldez/scoop-bucket.git\nscoop install gcg\n----\n\n| all\n| image:https://img.shields.io/github/release/ldez/gcg.svg?label=Binaries\u0026style=flat[\"Binaries\", link=\"https://github.com/ldez/gcg/releases\"]\na|\n* To get the binary just download the latest release for your OS/Arch from https://github.com/ldez/gcg/releases[the releases page]\n* Unzip the archive.\n* Add `gcg` in your `PATH`.\n\n| all\n| https://github.com/ldez/gcg[Sources]\na|\n[source,bash]\n----\ngo get -u github.com/ldez/gcg\n----\n\n|===\n\n== Examples\n\n[source,bash]\n----\ngcg -p\"v1.2.0-rc1\" -c\"v1.3.0-rc1\" -o\"containous\" -r\"traefik\" -t\"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\"\n----\n\n=== Next major release (RC1 on master)\n\nex: for the (non-existing) next version 1.4.0-rc1\n\n[source,mermaid]\n----\ngitGraph:\n    commit id:\"a\"\n    commit id:\"b\" tag:\"v1.3.0-rc1\" type:HIGHLIGHT\n    commit id:\"c\"\n    commit id:\"d\"\n    commit id:\"e\" tag:\"HEAD\" type:HIGHLIGHT\n----\n\n[source,bash]\n----\ngcg -b\"master\" -p\"v1.3.0-rc1\" -c\"master\" -f\"v1.4.0-rc1\" \\\n-o\"containous\" -r\"traefik\" -t\"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\" \\\n--exclude-label=\"area/infrastructure\" \\\n--enhancement-label=\"kind/enhancement\" --doc-label=\"area/documentation\" --bug-label=\"kind/bug/fix\" \\\n--debug\n----\n\n=== Next RC release (RC2 on a specific branch)\n\nex: for the (non-existing) version 1.3.0-rc2\n\n[source,mermaid]\n----\ngitGraph:\n    commit id:\"a\"\n    commit id:\"b\" tag:\"v1.3.0-rc1\" type:HIGHLIGHT\n    branch v1.3\n    checkout main\n    commit id:\"c\"\n    checkout v1.3\n    commit id:\"d\"\n    commit  id:\"e\"tag:\"HEAD\" type:HIGHLIGHT\n    checkout main\n    commit id:\"f\"\n    commit id:\"g\"\n----\n\n[source, bash]\n----\ngcg -b\"v1.3\" -p\"v1.3.0-rc1\" -c\"v1.3\" -f\"v1.3.0-rc2\" \\\n-o\"containous\" -r\"traefik\" \\\n--exclude-label=\"area/infrastructure\" \\\n--enhancement-label=\"kind/enhancement\" --doc-label=\"area/documentation\" --bug-label=\"kind/bug/fix\" \\\n--debug\n----\n\n=== Previous major release (Pre RC1)\n\nex: for the (existing) version 1.3.0-rc1\n\n[source,mermaid]\n----\ngitGraph:\n    commit id:\"a\"\n    commit id:\"b\" tag:\"v1.2.0-rc1\" type:HIGHLIGHT\n    branch v1.2\n    commit id:\"c\"\n    commit id:\"d\" tag:\"v1.2.0\"\n    commit id:\"e\"\n    commit id:\"f\" tag:\"v1.2.1\"\n    checkout main\n    commit id:\"g\"\n    merge v1.2\n    commit id:\"h\"\n    commit id:\"i\" tag:\"v1.3.0-rc1\" type:HIGHLIGHT\n    branch v1.3\n    commit id:\"j\"\n    commit id:\"k\"\n    checkout main\n    commit id:\"l\"\n    commit id:\"m\"\n----\n\n[source, bash]\n----\ngcg -b\"master\" -p\"v1.2.0-rc1\" -c\"v1.3.0-rc1\" \\\n-o\"containous\" -r\"traefik\" \\\n--exclude-label=\"area/infrastructure\" \\\n--enhancement-label=\"kind/enhancement\" --doc-label=\"area/documentation\" --bug-label=\"kind/bug/fix\" \\\n--debug\n----\n\n=== Previous RC release (between RC1 and RC2)\n\nex: for the (existing) version 1.3.0-rc2\n\n[source,mermaid]\n----\ngitGraph:\n    commit id:\"a\"\n    commit id:\"b\" tag:\"v1.3.0-rc1\" type:HIGHLIGHT\n    branch v1.3\n    commit id:\"c\"\n    commit id:\"d\" tag:\"v1.3.0-rc2\" type:HIGHLIGHT\n    commit id:\"e\"\n    commit id:\"f\"\n    checkout main\n    commit id:\"g\"\n    commit id:\"h\"\n----\n\n[source, bash]\n----\ngcg -b\"v1.3\" -p\"v1.3.0-rc1\" -c\"v1.3.0-rc2\" \\\n-o\"containous\" -r\"traefik\" \\\n--exclude-label=\"area/infrastructure\" \\\n--enhancement-label=\"kind/enhancement\" --doc-label=\"area/documentation\" --bug-label=\"kind/bug/fix\" \\\n--debug\n----\n\n=== Filtered Labels\n\n[source, bash]\n----\ngcg -b\"v1.3\" -p\"v1.3.0-rc1\" -c\"v1.3\" -f\"v1.3.0\"  \\\n-o\"containous\" -r\"traefik\" \\\n--exclude-label=\"area/infrastructure\" \\\n--enhancement-label=\"kind/enhancement\" --doc-label=\"area/documentation\" --bug-label=\"kind/bug/fix\" \\\n--dl-options.prefix-filter=\"area/,platform/\" \\\n--dl-options.suffix-exclude=\"documentation\" \\\n--dl-options.prefix-trim=\"area/provider/,area/middleware/,area/,platform/\" \\\n--debug\n----\n\n[source, bash]\n----\ngcg \\\n--base-branch=\"v1.3\" --previous-ref=\"v1.3.0-rc1\" \\\n--current-ref=\"v1.3\" --future-ref-name=\"v1.3.0\" \\\n--owner=\"containous\" --repo-name=\"traefik\" \\\n--exclude-label=\"area/infrastructure\" \\\n--enhancement-label=\"kind/enhancement\" --doc-label=\"area/documentation\" --bug-label=\"kind/bug/fix\" \\\n--dl-options.prefix-filter=\"area/,platform/\" \\\n--dl-options.suffix-exclude=\"documentation\" \\\n--dl-options.prefix-trim=\"area/provider/,area/middleware/,area/,platform/\" \\\n--debug\n----\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fldez%2Fgcg","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fldez%2Fgcg","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fldez%2Fgcg/lists"}