{"id":17497276,"url":"https://github.com/moox/github-release-from-changelog","last_synced_at":"2025-04-10T02:24:07.161Z","repository":{"id":1632867,"uuid":"43617347","full_name":"MoOx/github-release-from-changelog","owner":"MoOx","description":"Create GitHub releases from your changelog","archived":false,"fork":false,"pushed_at":"2023-07-13T00:26:55.000Z","size":252,"stargazers_count":64,"open_issues_count":2,"forks_count":10,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-03T00:09:12.118Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/MoOx.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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}},"created_at":"2015-10-03T22:31:51.000Z","updated_at":"2024-04-29T11:10:39.000Z","dependencies_parsed_at":"2024-06-18T13:48:28.658Z","dependency_job_id":"130bb2fc-54da-4a8f-8fb2-c6069605b7de","html_url":"https://github.com/MoOx/github-release-from-changelog","commit_stats":{"total_commits":67,"total_committers":9,"mean_commits":7.444444444444445,"dds":0.5970149253731343,"last_synced_commit":"970c6c8b6bec09a957625b9f5004d89028cbea87"},"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MoOx%2Fgithub-release-from-changelog","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MoOx%2Fgithub-release-from-changelog/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MoOx%2Fgithub-release-from-changelog/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MoOx%2Fgithub-release-from-changelog/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MoOx","download_url":"https://codeload.github.com/MoOx/github-release-from-changelog/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248143479,"owners_count":21054790,"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":[],"created_at":"2024-10-19T15:38:54.979Z","updated_at":"2025-04-10T02:24:07.130Z","avatar_url":"https://github.com/MoOx.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# github-release-from-changelog\n\n[![Test Status](https://github.com/MoOx/github-release-from-changelog/workflows/Test/badge.svg)](https://github.com/MoOx/github-release-from-changelog/actions)\n[![Version](https://img.shields.io/npm/v/github-release-from-changelog.svg?style=flat)](https://www.npmjs.com/package/github-release-from-changelog)\n\n\u003e Create GitHub releases from `CHANGELOG.md`\n\n**This tool _edits the git tag_ on GitHub and _create a GitHub release_ with the correct changelog section.**\n\nYou need:\n\n- a changelog file ([various filenames supported](https://github.com/MoOx/github-release-from-changelog/blob/master/github-release-from-changelog.js) automatically or specified via `--filename` option) with markdown titles that start with the version (eg: `# 1.2.0`, `## v1.2.0`, `# [1.2.0`...)\n- a `package.json` with a `version` field.\n- a git tag with the corresponding version in either `X.Y.Z` or `vX.Y.Z` formats.\n- a `GITHUB_TOKEN` as an env var. See \u003chttps://github.com/MoOx/npmpub#requirements\u003e for instructions.\n\n_Included in [npmpub](https://github.com/MoOx/npmpub) !_\n\n## Install\n\n```console\nnpm install github-release-from-changelog\n```\n\n## Usage\n\n```console\ngithub-release-from-changelog [--filename CustomChangelog.md]\n```\n\n### Options\n\n#### `--filename`\n\nSpecify your own filename\n\n#### `--dryRun`\n\nTest what the release will looks like\n\n#### `--debug`\n\nDisplay parsing information\n\n## Advanced Installation and Usage\n\ngithub-release-from-changelog is fully integrated in [npmpub](https://github.com/MoOx/npmpub).\nPlease follow the instructions at \u003chttps://github.com/MoOx/npmpub#install\u003e to install and use it.\nnpmpub automatically calls github-release-from-changelog by default.\n\ngithub-release-from-changelog also plays well with other publishing tools such as [release-it](https://www.npmjs.com/package/release-it).\nOne can create a release using release-it (which also updates `package.json`, but does not free you from maintaining `CHANGELOG.md` for yourself) and then use github-release-from-changelog to create the release on GitHub.\n\n## CONTRIBUTING\n\n- ⇄ Pull requests and ★ Stars are always welcome.\n- For bugs and feature requests, please create an issue.\n\n## CHANGELOG\n\nSee [CHANGELOG.md](CHANGELOG.md)\n\n## LICENSE\n\nThe license is MIT.\nSee [LICENSE](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmoox%2Fgithub-release-from-changelog","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmoox%2Fgithub-release-from-changelog","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmoox%2Fgithub-release-from-changelog/lists"}