{"id":18656546,"url":"https://github.com/zendesk/action-create-release","last_synced_at":"2025-07-29T18:04:54.841Z","repository":{"id":42833093,"uuid":"264787256","full_name":"zendesk/action-create-release","owner":"zendesk","description":"Github action to create releases","archived":false,"fork":false,"pushed_at":"2025-06-05T00:53:33.000Z","size":368,"stargazers_count":11,"open_issues_count":5,"forks_count":18,"subscribers_count":147,"default_branch":"master","last_synced_at":"2025-06-30T14:45:08.784Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/zendesk.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2020-05-18T00:51:05.000Z","updated_at":"2022-11-02T16:36:57.000Z","dependencies_parsed_at":"2024-10-05T19:30:28.142Z","dependency_job_id":"122569ef-e8a7-4254-a71d-6c2f60c6a30c","html_url":"https://github.com/zendesk/action-create-release","commit_stats":{"total_commits":9,"total_committers":3,"mean_commits":3.0,"dds":"0.33333333333333337","last_synced_commit":"ed250bfbb4e67d4ea4ab3c5d0cd531661463e168"},"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/zendesk/action-create-release","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zendesk%2Faction-create-release","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zendesk%2Faction-create-release/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zendesk%2Faction-create-release/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zendesk%2Faction-create-release/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zendesk","download_url":"https://codeload.github.com/zendesk/action-create-release/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zendesk%2Faction-create-release/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267729524,"owners_count":24135331,"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","status":"online","status_checked_at":"2025-07-29T02:00:12.549Z","response_time":2574,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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-11-07T07:23:56.248Z","updated_at":"2025-07-29T18:04:54.798Z","avatar_url":"https://github.com/zendesk.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n# GitHub Action - Releases API\nThis GitHub Action (written in JavaScript) wraps the  [Create a Release](https://developer.github.com/v3/repos/releases/#create-a-release) endpoint and [Auto Increment Tag Version ](#auto-increment---path-type---push-to-master) feature. Which allows to create tag automatically when pushed to the release branch. This is also an alternative to Samson Release functionality.\n\n\u003ca href=\"https://github.com/zendesk/action-create-release\"\u003e\u003cimg alt=\"GitHub Actions status\" src=\"https://github.com/zendesk/action-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| Parameter             | Description                                                                                | Required | Default      |\n| -------------------   | ------------------------------------------------------------------------------------------ | -------- | ------------ |\n| `tag_name`            | The name of the tag for this release.                            | N    | Auto Incremented |\n| `release_name`        | The name of the release.                                         | N    |  TAG_NAME        |\n| `body`                | Text describing the contents of the release                      | N    |  N/A             |\n| `draft`               | `true` to create a draft (unpublished) release, `false` to create a published one.          | N        |  `false`       |\n| `prerelease`          |  `true` to identify the release as a prerelease. `false` to identify the release as a full release. | N        |  `false`       |\n| `prerelease_suffix`   | The suffix added to a prerelease tag, if none already exists.                 | N        | `beta`       |\n| `auto_increment_type` | Used for auto-incrementing the tag version. One of (`major`, `minor`, `patch`, `prerelease`, `premajor`).  | N        | `patch` |\n| `tag_schema`          | Used for computing the tag schema. One of (`continuous`, `semantic`).  | N        | `continuous` |\n\n\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| Parameter           | Description                                                                  | \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| `previous_tag`      | The most recent tag found during auto incrementing the tag version.|\n| `current_tag`       | The tag used to create a Release.|\n                    \n\n## Example workflow - Create a release\n\n### Auto Increment - Patch type - Push to master\nOn every `push` to a `master` branch will create tag incrementally.\n\n```yaml\non:\n  push:\n    branches:\n      - master\n\nname: Create Release\n\njobs:\n  build:\n    name: Create Release\n    runs-on: ['self-hosted']\n    steps:\n      - name: Create Release\n        id: create_release\n        uses: zendesk/action-create-release@v1\n        env:\n          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n```\n\n***Sample Output:***\n```\nprevious_tag: v5.0.3\ncurrent_tag:  v5.0.4\nid:           123\nupload_url:   https://uploads.github.com/repos/zendesk/Hello-World/releases/1/assets\nhtml_url:     https://github.com/octocat/Hello-World/releases/v1.0.0\n```\n\n### Auto Increment types and outputs\n\n| Type              | Previous Tag        | Current Tag         | \n| ----------------- | ------------------- | ------------------- |\n| major             | `v5.0.1`            | `v6.0.0`            |\n| minor             | `v5.0.1`            | `v5.1.1`            |\n| patch             | `v5.0.1`            | `v5.0.2`            |\n| prerelease        | `v5.0.1`            | `v5.0.2-beta.0`     |\n| premajor          | `v5.0.1`            | `v6.0.1-beta.0`     |\n\n\n### Tag as parameter\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: ['self-hosted']\n    steps:\n      - name: Create Release\n        id: create_release\n        uses: zendesk/action-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 `@zendesk/action-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","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzendesk%2Faction-create-release","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzendesk%2Faction-create-release","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzendesk%2Faction-create-release/lists"}