{"id":25314180,"url":"https://github.com/weikangchia/gitcg","last_synced_at":"2025-07-15T07:37:16.371Z","repository":{"id":37920433,"uuid":"354247082","full_name":"weikangchia/gitcg","owner":"weikangchia","description":"Customizable Changelog Generator for GitLab and GitHub using Milestone","archived":false,"fork":false,"pushed_at":"2025-06-26T20:27:19.000Z","size":448,"stargazers_count":5,"open_issues_count":11,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-06-26T21:54:54.517Z","etag":null,"topics":["changelog-generator","developer-tools","gitlab","milestone","oclif","tools","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/weikangchia.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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}},"created_at":"2021-04-03T09:10:56.000Z","updated_at":"2024-04-11T07:01:51.000Z","dependencies_parsed_at":"2023-10-20T22:32:14.553Z","dependency_job_id":"8ca15195-69ff-496b-8a0f-77cd38ae0bb5","html_url":"https://github.com/weikangchia/gitcg","commit_stats":{"total_commits":131,"total_committers":3,"mean_commits":"43.666666666666664","dds":"0.36641221374045807","last_synced_commit":"8cb697226e168125c56d98ee443593350f700322"},"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"purl":"pkg:github/weikangchia/gitcg","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/weikangchia%2Fgitcg","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/weikangchia%2Fgitcg/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/weikangchia%2Fgitcg/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/weikangchia%2Fgitcg/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/weikangchia","download_url":"https://codeload.github.com/weikangchia/gitcg/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/weikangchia%2Fgitcg/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265418466,"owners_count":23761817,"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","developer-tools","gitlab","milestone","oclif","tools","typescript"],"created_at":"2025-02-13T16:54:57.017Z","updated_at":"2025-07-15T07:37:16.344Z","avatar_url":"https://github.com/weikangchia.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Git Changelog Generator\n\n**gitcg** is a customizable changelog generator for GitLab and GitHub using milestone.\n\n## Getting Started\n\n### Pre-requisites\n\n- Install [node](https://nodejs.org/en/download/)\n- Install gitcg\n  ```\n  npm install -g gitcg\n  ```\n\n### GitLab\n\n- Get a personal token (scopes: `read_api`)\n- Store it as a environment variable\n  ```export GITLAB_TOKEN=\u003cyour personal GitLab token\u003e```\n\n### GitHub\n- Get a personal token (scopes: `repo`)\n- Store it as a environment variable\n  ```export GITHUB_TOKEN=\u003cyour personal GitHub token\u003e```\n\n### Usage\n```sh-session\nUSAGE:\n    gitcg\n\nOPTIONS:\n    -m, --milestone=milestone        title of milestone\n    -p, --projectPath=projectPath    path to project\n    --config=config                  custom config file name (default is config.json)\n```\n\n**Examples**\n\n1. GitHub repo (e.g. https://github.com/weikangchia/gitcg)\n```\ngitcg -m \"v0.1.0\" -p \"weikangchia/gitcg\"\n```\n2. GitLab repo (e.g. https://gitlab.com/weikangchia/gitcg)\n```\ngitcg -m \"v0.1.0\" -p \"weikangchia/gitcg\"\n```\n3. Other config files\u003cbr/\u003e\n   If you are managing multiple repo or projects and have different configuration, you could create different configuration files in the config folder and use them.\n```\ngitcg -m \"v0.1.0\" -p \"weikangchia/gitcg\" --config=\"config-github.json\"\n```\n```\ngitcg -m \"v0.1.0\" -p \"weikangchia/gitcg\" --config=\"config-gitlab.json\"\n```\n\n## Configuration Options\n\nBy default **gitcg** reads all configurable options from `config.json` at the following location\n\n```\nUnix: ~/.config/gitcg\nWindows: %LOCALAPPDATA%\\gitcg\nCan be overridden with XDG_CONFIG_HOME\n```\n\nBelow are the available configurable options.\n\n- [service](#service)\n- [serviceUrl](#serviceUrl)\n- [sections](#sections)\n  - [title](#title)\n  - [labels](#labels)\n- [enableContributorsSection](#enableContributorsSection)\n- [contributorsToExclude](#contributorsToExclude)\n- [contributorTitle](#contributorTitle)\n- [enableExternalIssuesTracker](#enableExternalIssuesTracker)\n- [externalIssuesUrl](#externalIssuesUrl)\n- [externalIssuesProjects](#externalIssuesProjects)\n- [enableCommitSha](#enableCommitSha)\n\n### service\n\n| Name        | Value           |\n| ------------- |-------------|\n| type      | string |\n| mandatory | true |\n| supportedValues | gitlab, github |\n\n\nExample\n```json\n{\n  \"service\": \"gitlab\"\n}\n```\n\n### serviceUrl\n\n| Name        | Value           |\n| ------------- |-------------|\n| type      | string |\n| mandatory | true |\n\nExample\n```json\n{\n  \"service\": \"gitlab\",\n  \"serviceUrl\": \"https://gitlab.com\"\n}\n```\n\n### sections\n\n| Name        | Value           |\n| ------------- |-------------|\n| type      | array |\n| mandatory | false |\n\nExample\n```json\n{\n  \"service\": \"gitlab\",\n  \"serviceUrl\": \"https://gitlab.com\",\n  \"sections\": []\n}\n```\n\n#### title\n\n| Name        | Value           |\n| ------------- |-------------|\n| type      | string |\n| parent    | sections |\n| mandatory | true |\n\nExample\n```json\n{\n  \"service\": \"gitlab\",\n  \"serviceUrl\": \"https://gitlab.com\",\n  \"sections\": [\n    {\n      \"title\": \":star2: New Features\",\n      \"labels\": [\"feature\"]\n    }\n  ]\n}\n```\n\n#### labels\n\n| Name        | Value           |\n| ------------- |-------------|\n| type      | string |\n| parent    | sections |\n| mandatory | true |\n\nExample\n```json\n{\n  \"service\": \"gitlab\",\n  \"serviceUrl\": \"https://gitlab.com\",\n  \"sections\": [\n    {\n      \"title\": \":star2: New Features\",\n      \"labels\": [\"feature\"]\n    }\n  ]\n}\n```\n\n### enableContributorsSection\n\n| Name        | Value           |\n| ------------- |-------------|\n| type      | boolean |\n| mandatory | false |\n\nExample\n```json\n{\n  \"service\": \"gitlab\",\n  \"serviceUrl\": \"https://gitlab.com\",\n  \"enableContributorsSection\": true,\n  \"contributorTitle\": \":heart: Contributors\\nWe'd like to thank all the contributors who worked on this sprint!\"\n}\n```\n\n### contributorsToExclude\n\n| Name        | Value           |\n| ------------- |-------------|\n| type      | array |\n| mandatory | false |\n\nExample\n```json\n{\n  \"service\": \"gitlab\",\n  \"serviceUrl\": \"https://gitlab.com\",\n  \"enableContributorsSection\": true,\n  \"contributorsToExclude\": [\"user1\", \"user2\"],\n}\n```\n\n### contributorTitle\n\n| Name        | Value           |\n| ------------- |-------------|\n| type      | string |\n| mandatory | false |\n\nExample\n```json\n{\n  \"service\": \"gitlab\",\n  \"serviceUrl\": \"https://gitlab.com\",\n  \"enableContributorsSection\": true,\n  \"contributorTitle\": \":heart: Contributors\\nWe'd like to thank all the contributors who worked on this sprint!\"\n}\n```\n\n### enableExternalIssuesTracker\n\n| Name        | Value           |\n| ------------- |-------------|\n| type      | array |\n| mandatory | false |\n\nExample\n```json\n{\n  \"service\": \"gitlab\",\n  \"serviceUrl\": \"https://gitlab.com\",\n  \"enableExternalIssuesTracker\": true\n}\n```\n\n### externalIssuesUrl\n\n| Name        | Value           |\n| ------------- |-------------|\n| type      | string |\n| mandatory | false |\n\nExample\n```json\n{\n  \"service\": \"gitlab\",\n  \"serviceUrl\": \"https://gitlab.com\",\n  \"enableExternalIssuesTracker\": true,\n  \"externalIssuesUrl\": \"https://youtrack.com/issue\",\n}\n```\n\n### externalIssuesProjects\n\n| Name        | Value           |\n| ------------- |-------------|\n| type      | array |\n| mandatory | false |\n\nExample\n```json\n{\n  \"service\": \"gitlab\",\n  \"serviceUrl\": \"https://gitlab.com\",\n  \"enableExternalIssuesTracker\": true,\n  \"externalIssuesUrl\": \"https://youtrack.com/issue\",\n  \"externalIssuesProjects\": [\"PROJ1\", \"PROJ2\"],\n}\n```\n\n### enableCommitSha\n\n| Name        | Value           |\n| ------------- |-------------|\n| type      | boolean |\n| mandatory | false |\n\nExample\n```json\n{\n  \"service\": \"gitlab\",\n  \"serviceUrl\": \"https://gitlab.com\",\n  \"enableCommitSha\": true\n}\n```\n\n**Example**\n```\n{\n  \"service\": \"github\",\n  \"serviceUrl\": \"https://github.com\",\n  \"sections\": [\n    {\n      \"title\": \":star2: New Features\",\n      \"labels\": [\"feature\"]\n    },  \n    {\n      \"title\": \":bug: Bug Fixes\",\n      \"labels\": [\"bug\"]\n    },\n    {\n      \"title\": \":barber: Tasks\",\n      \"labels\": [\"task\"]\n    },\n    {\n      \"title\": \":lock: Security Fixes\",\n      \"labels\": [\"security\"]\n    },\n    {\n      \"title\": \":arrow_up: Dependency Upgrades\",\n      \"labels\": [\"dependency-upgrade\"]\n    }\n  ],\n  \"enableContributorsSection\": true,\n  \"contributorsToExclude\": [\"renovate_bot\"],\n  \"contributorTitle\": \":heart: Contributors\\nWe'd like to thank all the contributors who worked on this milestone!\",\n  \"enableExternalIssuesTracker\": false,\n  \"enableCommitSha\": true\n}\n```\n\n## License\n\nDistributed under the MIT License. See [LICENSE](license) for more information.\n\n## Contributing\nContributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.\n\n## Contact\n\nWei Kang - weikangchia[@]gmail.com\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fweikangchia%2Fgitcg","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fweikangchia%2Fgitcg","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fweikangchia%2Fgitcg/lists"}