{"id":15696802,"url":"https://github.com/crazy-max/ghaction-github-release","last_synced_at":"2025-08-22T18:31:55.848Z","repository":{"id":63772889,"uuid":"568518658","full_name":"crazy-max/ghaction-github-release","owner":"crazy-max","description":"GitHub Action for creating GitHub Releases","archived":false,"fork":false,"pushed_at":"2024-10-03T13:08:39.000Z","size":5569,"stargazers_count":7,"open_issues_count":5,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-10-18T07:32:38.966Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://github.com/marketplace/actions/github-release-action","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/crazy-max.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":".github/SUPPORT.md","governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"crazy-max","custom":"https://www.paypal.me/crazyws"}},"created_at":"2022-11-20T19:26:12.000Z","updated_at":"2024-06-23T11:12:11.000Z","dependencies_parsed_at":"2024-04-27T11:31:37.647Z","dependency_job_id":"31981593-a3e3-4db5-ab6d-a7e537018b00","html_url":"https://github.com/crazy-max/ghaction-github-release","commit_stats":{"total_commits":249,"total_committers":37,"mean_commits":6.72972972972973,"dds":0.3132530120481928,"last_synced_commit":"1f48d1672823d9dbfb518609c1ff2791a364ed32"},"previous_names":[],"tags_count":18,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crazy-max%2Fghaction-github-release","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crazy-max%2Fghaction-github-release/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crazy-max%2Fghaction-github-release/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crazy-max%2Fghaction-github-release/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/crazy-max","download_url":"https://codeload.github.com/crazy-max/ghaction-github-release/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":230626603,"owners_count":18255684,"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-10-03T19:09:59.883Z","updated_at":"2025-08-22T18:31:55.830Z","avatar_url":"https://github.com/crazy-max.png","language":"TypeScript","funding_links":["https://github.com/sponsors/crazy-max","https://www.paypal.me/crazyws"],"categories":[],"sub_categories":[],"readme":"[![GitHub release](https://img.shields.io/github/release/crazy-max/ghaction-github-release.svg?style=flat-square)](https://github.com/crazy-max/ghaction-github-release/releases/latest)\n[![GitHub marketplace](https://img.shields.io/badge/marketplace-github--release--action-blue?logo=github\u0026style=flat-square)](https://github.com/marketplace/actions/github-release-action)\n[![Test workflow](https://img.shields.io/github/actions/workflow/status/crazy-max/ghaction-github-release/test.yml?branch=master\u0026label=test\u0026logo=github\u0026style=flat-square)](https://github.com/crazy-max/ghaction-github-release/actions?workflow=test)\n[![Codecov](https://img.shields.io/codecov/c/github/crazy-max/ghaction-github-release?logo=codecov\u0026style=flat-square)](https://codecov.io/gh/crazy-max/ghaction-github-release)\n[![Become a sponsor](https://img.shields.io/badge/sponsor-crazy--max-181717.svg?logo=github\u0026style=flat-square)](https://github.com/sponsors/crazy-max)\n[![Paypal Donate](https://img.shields.io/badge/donate-paypal-00457c.svg?logo=paypal\u0026style=flat-square)](https://www.paypal.me/crazyws)\n\n## ⚠️ Abandoned project\n\nThis project is not maintained anymore and is abandoned. Feel free to fork and\nmake your own changes, or you can switch to https://github.com/softprops/action-gh-release.\n\n## About\n\nGitHub Action for creating GitHub Releases.\n\nThis repository is a fork of https://github.com/softprops/action-gh-release\n\n___\n\n* [Usage](#usage)\n * [Limit releases to pushes to tags](#limit-releases-to-pushes-to-tags)\n * [Uploading release assets](#uploading-release-assets)\n * [External release notes](#external-release-notes)\n* [Customizing](#customizing)\n * [inputs](#inputs)\n * [outputs](#outputs)\n * [environment variables](#environment-variables)\n* [Permissions](#permissions) \n* [Contributing](#contributing)\n* [License](#license)\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 is gated\npushes 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\n```yaml\nname: release\n\non:\n push:\n\njobs:\n release:\n runs-on: ubuntu-latest\n steps:\n -\n name: Checkout\n uses: actions/checkout@v3\n -\n name: Release\n uses: crazy-max/ghaction-github-release@v2\n if: startsWith(github.ref, 'refs/tags/')\n```\n\nYou can also use push config tag filter:\n\n```yaml\nname: release\n\non:\n push:\n tags:\n - \"v*.*.*\"\n\njobs:\n release:\n runs-on: ubuntu-latest\n steps:\n -\n name: Checkout\n uses: actions/checkout@v3\n -\n name: Release\n uses: crazy-max/ghaction-github-release@v2\n```\n\n### Uploading release assets\n\nYou can configure a number of options for your GitHub release and all are\noptional.\n\nA common case for GitHub releases is to upload your binary after its been\nvalidated and packaged. Use the `with.files` input to declare a\nnewline-delimited list of glob expressions matching the files you wish to\nupload to GitHub releases. If you'd like you can just list the files by name\ndirectly.\n\nBelow is an example of uploading a single asset named `release.txt`\n\n```yaml\nname: release\n\non:\n push:\n\njobs:\n release:\n runs-on: ubuntu-latest\n steps:\n -\n name: Checkout\n uses: actions/checkout@v3\n -\n name: Build\n run: echo ${{ github.sha }} \u003e release.txt\n -\n name: Test\n run: cat Release.txt\n -\n name: Release\n uses: crazy-max/ghaction-github-release@v2\n if: startsWith(github.ref, 'refs/tags/')\n with:\n files: release.txt\n```\n\nBelow is an example of uploading more than one asset with a GitHub release:\n\n```yaml\nname: release\n\non:\n push:\n\njobs:\n release:\n runs-on: ubuntu-latest\n steps:\n -\n name: Checkout\n uses: actions/checkout@v3\n -\n name: Build\n run: echo ${{ github.sha }} \u003e release.txt\n -\n name: Test\n run: cat Release.txt\n -\n name: Release\n uses: crazy-max/ghaction-github-release@v2\n if: startsWith(github.ref, 'refs/tags/')\n with:\n files: |\n release.txt\n LICENSE\n```\n\n\u003e **Warning**\n\u003e\n\u003e Notice the `|` in the yaml syntax above. That lets you effectively declare a\n\u003e multi-line yaml string. You can learn more about multi-line yaml syntax [here](https://yaml-multiline.info)\n\n### External release notes\n\nMany systems exist that can help generate release notes for you. This action\nsupports loading release notes from a path in your repository's build to allow\nfor the flexibility of using any changelog generator for your releases,\nincluding a human.\n\n```yaml\nname: release\n\non:\n push:\n\njobs:\n release:\n runs-on: ubuntu-latest\n steps:\n -\n name: Checkout\n uses: actions/checkout@v3\n -\n name: Generate Changelog\n run: echo \"# Good things have arrived\" \u003e ${{ github.workspace }}-CHANGELOG.txt\n -\n name: Release\n uses: crazy-max/ghaction-github-release@v2\n if: startsWith(github.ref, 'refs/tags/')\n with:\n body_path: ${{ github.workspace }}-CHANGELOG.txt\n # note you'll typically need to create a personal access token\n # with permissions to create releases in the other repo\n token: ${{ secrets.CUSTOM_GITHUB_TOKEN }}\n env:\n GITHUB_REPOSITORY: my_gh_org/my_gh_repo\n```\n\n## Customizing\n\n### inputs\n\nFollowing inputs can be used 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| `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| `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\u003e **Note**\n\u003e\n\u003e When providing a `body` and `body_path` at the same time, `body_path` will be\n\u003e attempted first, then falling back on `body` if the path can not be read from.\n\n\u003e **Note**\n\u003e\n\u003e When the release info keys (such as `name`, `body`, `draft`, `prerelease`, etc.)\n\u003e are not explicitly set and there is already an existing release for the tag,\n\u003e the release will retain its original info.\n\n### outputs\n\nFollowing outputs are available:\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\n### environment variables\n\nThe following environment variables can be used as `step.env` keys\n\n| Name | Description |\n|---------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------|\n| `GITHUB_TOKEN` | [GITHUB_TOKEN](https://help.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-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## 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)\ncan be set for an individual job, workflow, or for Actions as a whole.\n\n## Contributing\n\nWant to contribute? Awesome! The most basic way to show your support is to star the project, or to raise issues. If\nyou want to open a pull request, please read the [contributing guidelines](.github/CONTRIBUTING.md).\n\n## License\n\nMIT. See `LICENSE` for more details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcrazy-max%2Fghaction-github-release","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcrazy-max%2Fghaction-github-release","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcrazy-max%2Fghaction-github-release/lists"}