{"id":14070408,"url":"https://github.com/mikepenz/action-gh-release","last_synced_at":"2025-07-30T07:33:13.850Z","repository":{"id":49836416,"uuid":"304830531","full_name":"mikepenz/action-gh-release","owner":"mikepenz","description":"šŸ“¦ :octocat: GitHub Action for creating GitHub Releases","archived":false,"fork":true,"pushed_at":"2024-03-14T08:27:28.000Z","size":2547,"stargazers_count":5,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-08-13T07:17:51.949Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"softprops/action-gh-release","license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mikepenz.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"ko_fi":"softprops"}},"created_at":"2020-10-17T08:18:25.000Z","updated_at":"2024-02-09T12:04:46.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/mikepenz/action-gh-release","commit_stats":null,"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mikepenz%2Faction-gh-release","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mikepenz%2Faction-gh-release/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mikepenz%2Faction-gh-release/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mikepenz%2Faction-gh-release/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mikepenz","download_url":"https://codeload.github.com/mikepenz/action-gh-release/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228110228,"owners_count":17871150,"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-13T07:07:44.008Z","updated_at":"2024-12-04T12:30:50.685Z","avatar_url":"https://github.com/mikepenz.png","language":"TypeScript","funding_links":["https://ko-fi.com/softprops"],"categories":["TypeScript"],"sub_categories":[],"readme":"## Fork\n\nThis is a fork from https://github.com/softprops/action-gh-release with various patches and modifications applied - Please refer to the original action for any questions.\n\n\u003cdiv align=\"center\"\u003e\n šŸ“¦ :octocat:\n\u003c/div\u003e\n\u003ch1 align=\"center\"\u003e\n action gh-release\n\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\n A GitHub Action for creating GitHub Releases on Linux, Windows, and macOS virtual environments\n\u003c/p\u003e\n\n\u003cdiv align=\"center\"\u003e\n \u003cimg src=\"demo.png\"/\u003e\n\u003c/div\u003e\n\n\u003cbr /\u003e\n\n## šŸ¤ø Usage\n\n### šŸš„ Limit releases to pushes to tags\n\nTypically usage of this action involves adding a step to a build that\nis gated pushes to git tags. You may find `step.if` field helpful in accomplishing this\nas it maximizes the reuse value of your workflow for non-tag pushes.\n\nBelow is a simple example of `step.if` tag gating\n\n```yaml\nname: Main\n\non: push\n\njobs:\n build:\n runs-on: ubuntu-latest\n steps:\n - name: Checkout\n uses: actions/checkout@v4\n - name: Release\n uses: mikepenz/action-gh-release@{latest}\n if: startsWith(github.ref, 'refs/tags/')\n```\n\n### šŸ’… Customizing\n\n#### inputs\n\nThe following are optional as `step.with` keys\n\n| Name | Type | Description |\n| -------------------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `body` | String | Text communicating notable changes in this release |\n| `body_path` | String | Path to load text communicating notable changes in this release |\n| `draft` | Boolean | Indicator of whether or not this release is a draft |\n| `prerelease` | Boolean | Indicator of whether or not is a prerelease |\n| `files` | String | Newline-delimited globs of paths to assets to upload for release |\n| `name` | String | Name of the release. defaults to tag name |\n| `tag_name` | String | Name of a tag. defaults to `github.ref` |\n| `fail_on_unmatched_files` | Boolean | Indicator of whether to fail if any of the `files` globs match nothing |\n| `fail_on_asset_upload_issue` | Boolean | Indicator of whether to fail if any of the `assets` fails to upload |\n| `repository` | String | Name of a target repository in `\u003cowner\u003e/\u003crepo\u003e` format. Defaults to GITHUB_REPOSITORY env variable |\n| `target_commitish` | String | Commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Defaults to repository default branch. |\n| `make_latest` | String | Configuration to make the new release the latest. Defaults to 'true'. Can be one of: 'true', 'false', 'legacy' branch. |\n| `token` | String | Secret GitHub Personal Access Token. Defaults to `${{ github.token }}` |\n| `discussion_category_name` | String | If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. For more information, see [\"Managing categories for discussions in your repository.\"](https://docs.github.com/en/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository) |\n| `generate_release_notes` | Boolean | Whether to automatically generate the name and body for this release. If name is specified, the specified name will be used; otherwise, a name will be automatically generated. If body is specified, the body will be pre-pended to the automatically generated notes. See the [GitHub docs for this feature](https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes) for more information |\n| `append_body` | Boolean | Append to existing body instead of overwriting it |\n\nšŸ’” When providing a `body` and `body_path` at the same time, `body_path` will be\nattempted first, then falling back on `body` if the path can not be read from.\n\nšŸ’” When the release info keys (such as `name`, `body`, `draft`, `prerelease`, etc.)\nare not explicitly set and there is already an existing release for the tag, the\nrelease will retain its original info.\n\n#### outputs\n\nThe following outputs can be accessed via `${{ steps.\u003cstep-id\u003e.outputs }}` from this action\n\n| Name | Type | Description |\n| ------------ | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `url` | String | Github.com URL for the release |\n| `id` | String | Release ID |\n| `upload_url` | String | URL for uploading assets to the release |\n| `assets` | String | JSON array containing information about each uploaded asset, in the format given [here](https://docs.github.com/en/rest/releases/assets#get-a-release-asset) (minus the `uploader` field) |\n\nAs an example, you can use `${{ fromJSON(steps.\u003cstep-id\u003e.outputs.assets)[0].browser_download_url }}` to get the download URL of the first asset.\n\n#### environment variables\n\nThe following `step.env` keys are allowed as a fallback but deprecated in favor of using inputs.\n\n| Name | Description |\n| ------------------- | ------------------------------------------------------------------------------------------ |\n| `GITHUB_TOKEN` | GITHUB_TOKEN as provided by `secrets` |\n| `GITHUB_REPOSITORY` | Name of a target repository in `\u003cowner\u003e/\u003crepo\u003e` format. defaults to the current repository |\n\n\u003e **āš ļø Note:** This action was previously implemented as a Docker container, limiting its use to GitHub Actions Linux virtual environments only. With recent releases, we now support cross platform usage. You'll need to remove the `docker://` prefix in these versions\n\n### Permissions\n\nThis Action requires the following permissions on the GitHub integration token:\n\n```yaml\npermissions:\n contents: write\n```\n\nWhen used with `discussion_category_name`, additional permission is needed:\n\n```yaml\npermissions:\n contents: write\n discussions: write\n```\n\n[GitHub token permissions](https://docs.github.com/en/actions/security-guides/automatic-token-authentication#permissions-for-the-github_token) can be set for an individual job, workflow, or for Actions as a whole.\n\nDoug Tangren (softprops) 2019\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmikepenz%2Faction-gh-release","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmikepenz%2Faction-gh-release","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmikepenz%2Faction-gh-release/lists"}