{"id":13484296,"url":"https://github.com/actions/create-release","last_synced_at":"2025-10-05T22:31:06.373Z","repository":{"id":43753815,"uuid":"208154123","full_name":"actions/create-release","owner":"actions","description":"An Action to create releases via the GitHub Release API","archived":true,"fork":false,"pushed_at":"2021-03-03T19:02:36.000Z","size":463,"stargazers_count":1325,"open_issues_count":55,"forks_count":290,"subscribers_count":22,"default_branch":"main","last_synced_at":"2024-05-29T10:34:07.625Z","etag":null,"topics":["actions","github","github-actions","release","release-automation"],"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/actions.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-09-12T22:06:28.000Z","updated_at":"2024-05-25T16:34:10.000Z","dependencies_parsed_at":"2022-11-23T11:49:49.104Z","dependency_job_id":null,"html_url":"https://github.com/actions/create-release","commit_stats":{"total_commits":55,"total_committers":20,"mean_commits":2.75,"dds":0.6909090909090909,"last_synced_commit":"4c11c9fe1dcd9636620a16455165783b20fc7ea0"},"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/actions%2Fcreate-release","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/actions%2Fcreate-release/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/actions%2Fcreate-release/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/actions%2Fcreate-release/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/actions","download_url":"https://codeload.github.com/actions/create-release/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":215181344,"owners_count":15840711,"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","release-automation"],"created_at":"2024-07-31T17:01:22.032Z","updated_at":"2025-10-05T22:31:01.008Z","avatar_url":"https://github.com/actions.png","language":"JavaScript","readme":"# GitHub Action - Releases API\n\n**Please note:** This repository is currently unmaintained by a team of developers at GitHub. The \nrepository is here and you can use it as an example, or in Actions. However please be aware that \nwe are not going to be updating issues or pull requests on this repository.\n\n**Maintained Actions:**\n* [elgohr/Github-Release-Action](https://github.com/elgohr/Github-Release-Action)\n* [marvinpinto/action-automatic-releases](https://github.com/marvinpinto/action-automatic-releases)\n* [softprops/action-gh-release](https://github.com/softprops/action-gh-release)\n* [ncipollo/release-action](https://github.com/ncipollo/release-action)\n\n\nTo reflect this state we’ve marked this repository as Archived.\n\nIf you are having an issue or question about GitHub Actions then please [contact customer support](https://help.github.com/en/articles/about-github-actions#contacting-support).\n\nIf you have found a security issue [please submit it here](https://hackerone.com/github).\n\n---\n\nThis GitHub Action (written in JavaScript) 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\u003ca href=\"https://github.com/actions/create-release\"\u003e\u003cimg alt=\"GitHub Actions status\" src=\"https://github.com/actions/create-release/workflows/Tests/badge.svg\"\u003e\u003c/a\u003e\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@v2\n      - name: Create Release\n        id: create_release\n        uses: actions/create-release@v1\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## Contributing\nWe would love you to contribute to `@actions/create-release`, pull requests are welcome! Please see the [CONTRIBUTING.md](CONTRIBUTING.md) for more information.\n\n## License\nThe scripts and documentation in this project are released under the [MIT License](LICENSE)\n","funding_links":[],"categories":["JavaScript","Official Resources","Uncategorized"],"sub_categories":["Official Actions","Uncategorized"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Factions%2Fcreate-release","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Factions%2Fcreate-release","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Factions%2Fcreate-release/lists"}