{"id":15728863,"url":"https://github.com/chantsune/release-with-commit","last_synced_at":"2025-06-12T21:12:38.958Z","repository":{"id":37129159,"uuid":"281584204","full_name":"ChanTsune/release-with-commit","owner":"ChanTsune","description":"Create release with commit","archived":false,"fork":false,"pushed_at":"2025-06-03T15:56:20.000Z","size":3135,"stargazers_count":6,"open_issues_count":5,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-06-04T02:00:02.721Z","etag":null,"topics":["github","github-actions"],"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/ChanTsune.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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":["ChanTsune"]}},"created_at":"2020-07-22T05:32:49.000Z","updated_at":"2025-06-03T15:56:22.000Z","dependencies_parsed_at":"2023-10-24T06:29:53.361Z","dependency_job_id":"8a2a49ab-874d-4a0d-ab17-d679918f560a","html_url":"https://github.com/ChanTsune/release-with-commit","commit_stats":{"total_commits":507,"total_committers":4,"mean_commits":126.75,"dds":"0.29980276134122286","last_synced_commit":"28a6c7f33a03ede35ce2503867f5ba2dc290de56"},"previous_names":[],"tags_count":17,"template":false,"template_full_name":null,"purl":"pkg:github/ChanTsune/release-with-commit","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ChanTsune%2Frelease-with-commit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ChanTsune%2Frelease-with-commit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ChanTsune%2Frelease-with-commit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ChanTsune%2Frelease-with-commit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ChanTsune","download_url":"https://codeload.github.com/ChanTsune/release-with-commit/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ChanTsune%2Frelease-with-commit/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259531602,"owners_count":22872137,"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":["github","github-actions"],"created_at":"2024-10-03T23:07:03.169Z","updated_at":"2025-06-12T21:12:38.924Z","avatar_url":"https://github.com/ChanTsune.png","language":"TypeScript","readme":"# GitHub Action - Release-with-commit\n\nThis GitHub Action (written in TypeScript) wraps the [GitHub Release API](https://developer.github.com/v3/repos/releases/), specifically the [Create a Release](https://developer.github.com/v3/repos/releases/#create-a-release) endpoint, to allow you to leverage GitHub Actions to create releases.\n\n## Usage\n\n### Pre-requisites\n\nCreate a workflow `.yml` file in your `.github/workflows` directory. An [example workflow](#example-workflow---release-with-commit) is available below. For more information, reference the GitHub Help Documentation for [Creating a workflow file](https://help.github.com/en/articles/configuring-a-workflow#creating-a-workflow-file).\n\n### Inputs\n\nFor more information on these inputs, see the [API Documentation](https://developer.github.com/v3/repos/releases/#input)\n\n- `regexp`: The pattern of commit message. Create a release if commit message match this.\n- `regexp_options`: The option of `regexp`. for more details, see [Advanced Searching With Flags](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#Advanced_Searching_With_Flags)\n- `tag_name`: The name of the tag for this release.\n- `release_name`: The name of the release.\n- `body`: Text describing the contents of the release. Optional, and not needed if using `body_path`.\n- `body_path`: A file with contents describing the release. Optional, and not needed if using `body`.\n- `draft`: `true` to create a draft (unpublished) release, `false` to create a published one. Default: `false`\n- `prerelease`: `true` to identify the release as a prerelease. `false` to identify the release as a full release. Default `false`\n\n### Outputs\n\nFor more information on these outputs, see the [API Documentation](https://developer.github.com/v3/repos/releases/#response-4) for an example of what these outputs look like\n\n- `id`: The release ID\n- `html_url`: The URL users can navigate to in order to view the release. i.e. `https://github.com/octocat/Hello-World/releases/v1.0.0`\n- `upload_url`: The URL for uploading assets to the release, which could be used by GitHub Actions for additional uses, for example the [`@actions/upload-release-asset`](https://www.github.com/actions/upload-release-asset) GitHub Action\n- `created`: The Boolean value of whether a release was created\n- `tag_name`: The name of the created tag_name\n\n### Example workflow - release with commit\n\nOn every `push` to a commit message matching the `regexp`, [create a release](https://developer.github.com/v3/repos/releases/#create-a-release):\n\n```yaml\nname: Release with commit\n\non:\n  push:\n    branches:\n      - master\njobs:\n  release:\n    runs-on: ubuntu-latest\n    steps:\n      - uses: ChanTsune/release-with-commit@v2.8.0\n        with:\n          regexp: \"Release ((\\\\d+([.]\\\\d+)*)-(alpha|beta|rc)\\\\d*)((\\\\s|\\\\S)*)\"\n          regexp_options: \"us\"\n          release_name: \"version $1\"\n          tag_name: \"v$1\"\n          body: \"$5\"\n          draft: false\n          prerelease: false\n        env:\n          GITHUB_TOKEN: '${{ secrets.GITHUB_TOKEN }}' # This token is provided by Actions, you do not need to create your own token\n```\n\nThis will create a [Release](https://help.github.com/en/articles/creating-releases), as well as a [`release` event](https://developer.github.com/v3/activity/events/types/#releaseevent), which could be handled by a third party service, or by GitHub Actions for additional uses, for example the [`@actions/upload-release-asset`](https://www.github.com/actions/upload-release-asset) GitHub Action. This uses the `GITHUB_TOKEN` provided by the [virtual environment](https://help.github.com/en/github/automating-your-workflow-with-github-actions/virtual-environments-for-github-actions#github_token-secret), so no new token is needed.\n\n## Contributing\n\nWe would love you to contribute to `@ChanTsune/release-with-commit`, pull requests are welcome! Please see the [CONTRIBUTING.md](CONTRIBUTING.md) for more information.\n\n## License\n\nThe scripts and documentation in this project are released under the [MIT License](LICENSE)\n","funding_links":["https://github.com/sponsors/ChanTsune"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchantsune%2Frelease-with-commit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchantsune%2Frelease-with-commit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchantsune%2Frelease-with-commit/lists"}