{"id":20655721,"url":"https://github.com/kaiwedekind/create-release","last_synced_at":"2026-05-02T11:39:11.334Z","repository":{"id":220477369,"uuid":"751174591","full_name":"KaiWedekind/create-release","owner":"KaiWedekind","description":"An Action to create releases via the GitHub Release API","archived":false,"fork":false,"pushed_at":"2024-02-02T09:25:57.000Z","size":321,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-17T11:14:45.389Z","etag":null,"topics":["actions","github","github-actions","release-automation"],"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/KaiWedekind.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":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2024-02-01T04:29:40.000Z","updated_at":"2024-02-02T08:12:16.000Z","dependencies_parsed_at":"2024-02-02T09:52:19.037Z","dependency_job_id":null,"html_url":"https://github.com/KaiWedekind/create-release","commit_stats":null,"previous_names":["kaiwedekind/create-release"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KaiWedekind%2Fcreate-release","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KaiWedekind%2Fcreate-release/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KaiWedekind%2Fcreate-release/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KaiWedekind%2Fcreate-release/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/KaiWedekind","download_url":"https://codeload.github.com/KaiWedekind/create-release/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242762735,"owners_count":20181266,"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":["actions","github","github-actions","release-automation"],"created_at":"2024-11-16T18:12:24.843Z","updated_at":"2026-05-02T11:39:11.277Z","avatar_url":"https://github.com/KaiWedekind.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# GitHub Action - Releases API\n\n---\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### Pre-requisites\nCreate a workflow `.yml` file in your `.github/workflows` directory. An [example workflow](#example-workflow---create-a-release) 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\nFor more information on these inputs, see the [API Documentation](https://developer.github.com/v3/repos/releases/#input)\n\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- `commitish` : Any branch or commit SHA the Git tag is created from, unused if the Git tag already exists. Default: SHA of current commit\n- `owner`: The name of the owner of the repo. Used to identify the owner of the repository.  Used when cutting releases for external repositories.  Default: Current owner\n- `repo`: The name of the repository. Used to identify the repository on which to release.  Used when cutting releases for external repositories. Default: Current repository\n\n#### `body_path`\nThe `body_path` is valuable for dynamically creating a `.md` within code commits and even within the Github Action steps leading up to the `create-release`.\n\n### Outputs\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\n### Example workflow - create a release\nOn every `push` to a tag matching the pattern `v*`, [create a release](https://developer.github.com/v3/repos/releases/#create-a-release):\n\n```yaml\non:\n  push:\n    # Sequence of patterns matched against refs/tags\n    tags:\n      - 'v*' # Push events to matching v*, i.e. v1.0, v20.15.10\n\nname: Create Release\n\njobs:\n  build:\n    name: Create Release\n    runs-on: ubuntu-latest\n    steps:\n      - name: Checkout code\n        uses: actions/checkout@v4\n      - name: Create Release\n        id: create_release\n        uses: KaiWedekind/create-release@v1.0.0\n        env:\n          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # This token is provided by Actions, you do not need to create your own token\n        with:\n          tag_name: ${{ github.ref }}\n          release_name: Release ${{ github.ref }}\n          body: |\n            Changes in this Release\n            - First Change\n            - Second Change\n          draft: false\n          prerelease: false\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## License\nThe scripts and documentation in this project are released under the [MIT License](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkaiwedekind%2Fcreate-release","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkaiwedekind%2Fcreate-release","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkaiwedekind%2Fcreate-release/lists"}