{"id":20079639,"url":"https://github.com/pmq20/spreadtheword","last_synced_at":"2025-10-13T19:16:29.187Z","repository":{"id":42171193,"uuid":"139124486","full_name":"pmq20/spreadtheword","owner":"pmq20","description":"Automatically generate a release-note document based on git commit messages.","archived":false,"fork":false,"pushed_at":"2023-01-20T12:15:42.000Z","size":66,"stargazers_count":3,"open_issues_count":5,"forks_count":2,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-10-09T22:39:16.151Z","etag":null,"topics":["git","gitlab","google-translate","latex","release-automation","release-engineering","release-helper","wrike"],"latest_commit_sha":null,"homepage":"","language":"Ruby","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/pmq20.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}},"created_at":"2018-06-29T08:42:02.000Z","updated_at":"2024-03-19T04:07:52.000Z","dependencies_parsed_at":"2023-02-12T02:02:05.346Z","dependency_job_id":null,"html_url":"https://github.com/pmq20/spreadtheword","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/pmq20/spreadtheword","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pmq20%2Fspreadtheword","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pmq20%2Fspreadtheword/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pmq20%2Fspreadtheword/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pmq20%2Fspreadtheword/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pmq20","download_url":"https://codeload.github.com/pmq20/spreadtheword/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pmq20%2Fspreadtheword/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279016887,"owners_count":26085884,"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","status":"online","status_checked_at":"2025-10-13T02:00:06.723Z","response_time":61,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["git","gitlab","google-translate","latex","release-automation","release-engineering","release-helper","wrike"],"created_at":"2024-11-13T15:23:51.356Z","updated_at":"2025-10-13T19:16:29.148Z","avatar_url":"https://github.com/pmq20.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\" style=\"border-bottom: none;\"\u003eSpread the Word\u003c/h1\u003e\n\u003ch3 align=\"center\"\u003eAutomatically generate a release-note document based on git commit messages\u003c/h3\u003e\n\u003cp align=\"center\"\u003e\n\u003ca href=\"https://travis-ci.org/pmq20/spreadtheword\"\u003e\n  \u003cimg alt=\"Build Status\" src=\"https://travis-ci.org/pmq20/spreadtheword.svg?branch=master\" /\u003e\n\u003c/a\u003e\n\u003ca href=\"https://ci.appveyor.com/project/pmq20/spreadtheword/branch/master\"\u003e\n  \u003cimg alt=\"Build Status\" src=\"https://ci.appveyor.com/api/projects/status/xdb4p03gvrjr0m6m?svg=true\" /\u003e\n\u003c/a\u003e\n\u003ca href=\"https://codecov.io/gh/pmq20/spreadtheword\"\u003e\n  \u003cimg alt=\"codecov\" src=\"https://codecov.io/gh/pmq20/spreadtheword/branch/master/graph/badge.svg\" /\u003e\n\u003c/a\u003e\n\u003ca href=\"https://snyk.io/test/github/pmq20/spreadtheword\"\u003e\n  \u003cimg src=\"https://snyk.io/test/github/pmq20/spreadtheword/badge.svg\" alt=\"Known Vulnerabilities\" data-canonical-src=\"https://snyk.io/test/github/pmq20/spreadtheword?targetFile=Frontend%2Fpackage.json\" style=\"max-width:100%;\"\u003e\n\u003c/a\u003e\n\u003ca href=\"http://isitmaintained.com/project/pmq20/spreadtheword\"\u003e\n  \u003cimg alt=\"Average time to resolve an issue\" src=\"http://isitmaintained.com/badge/resolution/pmq20/spreadtheword.svg\" /\u003e\n\u003c/a\u003e\n\u003ca href=\"http://isitmaintained.com/project/pmq20/spreadtheword\"\u003e\n  \u003cimg alt=\"Percentage of issues still open\" src=\"http://isitmaintained.com/badge/open/pmq20/spreadtheword.svg\" /\u003e\n\u003c/a\u003e\n\u003c/p\u003e\n\n## Features\n\n* Multiple projects are supported, which means git messages from multiple repositories can be merged to produce a unified release document\n* Multiple output formats are supported, e.g. LaTeX\n* Integrates with Wrike and GitLab to fetch developement task titles\n* Integrates with Google Translate to automatically translate messages to English\n* Caches Google Translate results on your local disk (`~/.spreadtheword`) so that Google API could incur less fee and it saves your money\n\n## Commit Message Conventions\n\n- `{#1}` or `#1` means issue #1 of Gitlab. Eg. `{#63} add backend code for fields` or `fix #23`;\n- `{prj#1}` or `prj#1` means issue #1 of Gitlab project `prj`. Eg. `{UI#1} add code for forms` or `fix UI#23`;\n- `{W1}` means Wrike task `XXX` as in Wrike's permalink `https://www.wrike.com/open.htm?id=XXX`. Eg. `{W4123780} fix config files`.\n\n## Install\n\n    gem install spreadtheword\n\n## Usage\n\n    spreadtheword [PROJECT 1] [PROJECT 2]...[PROJECT N] [OPTION 1] [OPTION 2]...[OPTION N]\n          --author=STRING              Specifies the author of the output document. Default: user.name of git config\n          --console                    If present, start the console after spreadtheword initializes.\n          --google-translate-key=STRING\n                                      Specifies a Google Translate API access key and translate commit messages that contain non-ASCII characters to English.\n      -h, --help                       Prints this help and exit\n          --gitlab-endpoint=URL        Specifies GitLab API endpoint URL.\n          --gitlab-token=STRING        Specifies the OAuth access token of your GitLab.\n          --quiet                      If present, spreadtheword would not output anything to stderr.\n          --since=TAG/COMMIT-SHA1      Specifies the begining from which the git commits will be fetched. Default: the first commit\n          --title=STRING               Specifies the title of the output document. Default: \"Relase Notes\"\n          --until=TAG/COMMIT-SHA1      Specifies the end to which the git commits will be fetched. Default: master\n      -v, --version                    Prints the version of spreadtheword and exit\n          --wrike-token=STRING         Specifies the access token of your Wrike API app.\n\n## Notes\n\n* If no projects were provided, the current directory would be used as the sole project directory;\n* If multiple projects were provided, the git commit messages of those projects would be merged;\n* If no options were specified, their default (see below) will be used.\n\n## Example\n\n    spreadtheword                                     \\\n      /projects/X                                     \\\n      /projects/Y                                     \\\n      --since=v1.5                                    \\\n      --until=origin/releasing                        \\\n      --title=\"Your Project v1.6 Release Notes\"       \\\n      --author=\"Your Company, Inc.\"                   \\\n      --google-translate-key=\"XXX\"                    \\\n      --gitlab-endpoint=\"https://example.net/api/v4\"  \\\n      --gitlab-token=\"XXX\"                            \\\n      --wrike-token=\"XXX\"                             \\\n      \u003e v1.6.tex\n\nHint: you might need to set environment variable `LANG=en_US.UTF-8` to support wide characters of git log messages.\n\n## License\n\nMIT\n\n## See Also\n\n- [gitlab](https://github.com/narkoz/gitlab): Ruby client and CLI for GitLab API.\n- [wrike3](https://github.com/morshedalam/wrike3): Ruby client for the Wrike API V3.\n- [google-cloud-translate](https://github.com/GoogleCloudPlatform/google-cloud-ruby/tree/master/google-cloud-translate): the official library for Google Cloud Translation API.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpmq20%2Fspreadtheword","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpmq20%2Fspreadtheword","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpmq20%2Fspreadtheword/lists"}