{"id":13905484,"url":"https://github.com/zestia/hubrelease","last_synced_at":"2025-07-18T02:33:39.922Z","repository":{"id":29638295,"uuid":"33179601","full_name":"zestia/hubrelease","owner":"zestia","description":"Generate release notes from closed issues and merged pull requests","archived":true,"fork":false,"pushed_at":"2017-11-27T15:56:35.000Z","size":174,"stargazers_count":55,"open_issues_count":0,"forks_count":1,"subscribers_count":23,"default_branch":"master","last_synced_at":"2024-11-25T13:38:34.731Z","etag":null,"topics":[],"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/zestia.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":"2015-03-31T10:32:19.000Z","updated_at":"2023-01-28T14:19:10.000Z","dependencies_parsed_at":"2022-07-25T18:47:27.110Z","dependency_job_id":null,"html_url":"https://github.com/zestia/hubrelease","commit_stats":null,"previous_names":[],"tags_count":29,"template":false,"template_full_name":null,"purl":"pkg:github/zestia/hubrelease","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zestia%2Fhubrelease","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zestia%2Fhubrelease/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zestia%2Fhubrelease/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zestia%2Fhubrelease/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zestia","download_url":"https://codeload.github.com/zestia/hubrelease/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zestia%2Fhubrelease/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265692399,"owners_count":23812198,"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-08-06T23:01:16.800Z","updated_at":"2025-07-18T02:33:39.438Z","avatar_url":"https://github.com/zestia.png","language":"Ruby","funding_links":[],"categories":["Ruby"],"sub_categories":[],"readme":"# hubrelease\n\n**DEPRECATED**: hubrelease has been deprecated in favour of\n[releasekit][releasekit]. Which is a functional rewrite using Go over Ruby.\n\nGenerate release notes from closed issues and merged pull requests. Then create\na new release, or update an existing release on GitHub.\n\n[releasekit]: https://github.com/tombell/releasekit\n\n## Installation\n\nInstall the gem:\n\n    [sudo] gem install hubrelease\n\n## Usage\n\n### Arguments\n\n**Required:**\n\n- `--token` your GitHub API token, which you can generate in [your settings page on GitHub](https://github.com/settings/applications)\n- `--repo` the repo in the format `username/project`\n\n**Release Type:**\n\n- `--init` create the first release for the repo\n- `--prev` the previous release tag name (must exist on GitHub)\n- `--new` the new release tag name (must exist on GitHub)\n- `--master` use `master` as the ref for the next release, use instead of `--new`\n\n**Optional:**\n\n- `--prerelease` mark the release as pre-release on GitHub\n- `--attach` a path to the asset to attach to the release\n- `--labels` a comma separated list (`--labels wontfix,question,enhancement`) to add to items\n- `--reverts` include revert commits in the release notes\n- `--watch` a file path to watch for changes in commits\n- `--output` print the release notes instead of creating a release on GitHub\n\n### Release Types\n\nYou can do any of the following:\n\n- Generate your very first release\n- Generate a new release from a previous tag, and new tag\n- Generate release notes from a previous tag, to a branch or master\n\nClosed issues and pull requests are included in the release notes.\n\n- Issues closed by a pull request are **excluded**\n- Issues closed by a commit, but not a pull request are **included**\n- All other issues are **excluded**\n- Pull requests\n\n### Generating an Initial Release\n\nThis will generate the very first release for a repository, you skip the\n`--prev` option and specify `--init` instead:\n\n    hubrelease --repo zestia/hubrelease --token $GITHUB_API_TOKEN --init --new v0.0.1\n\n### Generating a New Release\n\nThis will generate a new release after the first:\n\n    hubrelease --repo zestia/hubrelease --prev v0.1.0 --new v0.2.0 --token $GITHUB_API_TOKEN\n\nThis will either create a new release or update an existing release.\n\n### Generating Release Notes for Master\n\nThis will generate a new release notes between the given tag ref and `master`:\n\n    hubrelease --repo zestia/hubrelease --token $GITHUB_API_TOKEN --prev v0.1.0 --master\n\nThis will always output the release notes, and never create/update releases on\nGitHub.\n\n### Generating Release Notes for a Branch\n\nThis will generate a new release notes between the given tag ref and the branch:\n\n    hubrelease --repo zestia/hubrelease --token $GITHUB_API_TOKEN --prev v0.1.0 --branch my-feature\n\nThis will always output the release notes, and never create/update releases on\nGitHub.\n\n### Labels\n\nIf you specify any number of labels, the issues/commits marked with those labels\nwill include them in the release notes.\n\n### Attachments\n\nIf you specify any number of attachments, they will be uploaded and included in\nthe release.\n\n### Reverts\n\nIf you specify to include reverts, this will include any commits starting with\n\"Revert\" in the release notes.\n\n### Watched Files\n\nIf you specify any number of files to watch, any changes to those files in the\nrange of the commits will be included at the end of the release. It will list\neach commit they changed, with the most recent first\n\n## Contribute\n\nHere's the most direct way to get your work merged into the project:\n\n- Fork the project\n- Clone down your fork\n- Create a feature branch\n- Hack away\n- If necessary, rebase your commits into logical chunks, without errors\n- Push the branch up\n- Send a pull request for your branch\n\n##  License\n\nSee `LICENSE` for more details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzestia%2Fhubrelease","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzestia%2Fhubrelease","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzestia%2Fhubrelease/lists"}