{"id":13529113,"url":"https://github.com/actions/upload-release-asset","last_synced_at":"2025-10-05T22:31:07.046Z","repository":{"id":41344764,"uuid":"208154141","full_name":"actions/upload-release-asset","owner":"actions","description":"An Action to upload a release asset via the GitHub Release API","archived":true,"fork":false,"pushed_at":"2021-03-03T19:05:40.000Z","size":209,"stargazers_count":684,"open_issues_count":52,"forks_count":188,"subscribers_count":13,"default_branch":"main","last_synced_at":"2024-09-22T02:31:37.655Z","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:39.000Z","updated_at":"2024-09-20T10:42:17.000Z","dependencies_parsed_at":"2022-11-23T11:49:49.611Z","dependency_job_id":null,"html_url":"https://github.com/actions/upload-release-asset","commit_stats":{"total_commits":35,"total_committers":8,"mean_commits":4.375,"dds":"0.34285714285714286","last_synced_commit":"ef2adfe8cb8ebfa540930c452c576b3819990faa"},"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/actions%2Fupload-release-asset","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/actions%2Fupload-release-asset/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/actions%2Fupload-release-asset/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/actions%2Fupload-release-asset/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/actions","download_url":"https://codeload.github.com/actions/upload-release-asset/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":219866870,"owners_count":16554271,"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-08-01T07:00:33.324Z","updated_at":"2025-10-05T22:31:01.715Z","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* [softprops/action-gh-release](https://github.com/softprops/action-gh-release)\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 [Upload a Release Asset](https://developer.github.com/v3/repos/releases/#upload-a-release-asset) endpoint, to allow you to leverage GitHub Actions to upload release assets.\n\n\u003ca href=\"https://github.com/actions/upload-release-asset\"\u003e\u003cimg alt=\"GitHub Actions status\" src=\"https://github.com/actions/upload-release-asset/workflows/Tests/badge.svg\"\u003e\u003c/a\u003e\n\n## Usage\n### Pre-requisites\nCreate a workflow `.yml` file in your repositories `.github/workflows` directory. An [example workflow](#example-workflow---upload-a-release-asset) 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). You also will need to have a release to upload your asset to, which could be created programmatically by [`@actions/create-release`](https://www.github.com/actions/create-release) as show in the example workflow.\n\n### Inputs\nFor more information on these inputs, see the [API Documentation](https://developer.github.com/v3/repos/releases/#input-2)\n\n- `upload_url`: The URL for uploading assets to the release, which could come from another GitHub Action, for example the [`@actions/create-release`](https://www.github.com/actions/create-release) GitHub Action\n\n### Outputs\nFor more information on these outputs, see the [API Documentation](https://developer.github.com/v3/repos/releases/#response-for-successful-upload) for an example of what these outputs look like\n\n- `id`: The ID of the asset\n- `browser_download_url`: The URL users can navigate to in order to download the release asset. i.e. `https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip`\n\n### Example workflow - upload a release asset\nOn every `push` to a tag matching the pattern `v*`, [create a release](https://developer.github.com/v3/repos/releases/#create-a-release) and [upload a release asset](https://developer.github.com/v3/repos/releases/#upload-a-release-asset). This Workflow example assumes you have the [`@actions/create-release`](https://www.github.com/actions/create-release) Action in a previous step:\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: Upload Release Asset\n\njobs:\n  build:\n    name: Upload Release Asset\n    runs-on: ubuntu-latest\n    steps:\n      - name: Checkout code\n        uses: actions/checkout@v2\n      - name: Build project # This would actually build your project, using zip for an example artifact\n        run: |\n          zip --junk-paths my-artifact README.md\n      - name: Create Release\n        id: create_release\n        uses: actions/create-release@v1\n        env:\n          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n        with:\n          tag_name: ${{ github.ref }}\n          release_name: Release ${{ github.ref }}\n          draft: false\n          prerelease: false\n      - name: Upload Release Asset\n        id: upload-release-asset \n        uses: actions/upload-release-asset@v1\n        env:\n          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n        with:\n          upload_url: ${{ steps.create_release.outputs.upload_url }} # This pulls from the CREATE RELEASE step above, referencing it's ID to get its outputs object, which include a `upload_url`. See this blog post for more info: https://jasonet.co/posts/new-features-of-github-actions/#passing-data-to-future-steps \n          asset_path: ./my-artifact.zip\n          asset_name: my-artifact.zip\n          asset_content_type: application/zip\n```\n\nThis will upload a release artifact to an existing release, outputting the `browser_download_url` for the asset which could be handled by a third party service, or by GitHub Actions for additional uses. For more information, see the GitHub Documentation for the [upload a release asset](https://developer.github.com/v3/repos/releases/#upload-a-release-asset) endpoint. \n\n## Contributing\nWe would love you to contribute to `@actions/upload-release-asset`, 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":["Official Resources","Uncategorized"],"sub_categories":["Official Actions","Uncategorized"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Factions%2Fupload-release-asset","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Factions%2Fupload-release-asset","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Factions%2Fupload-release-asset/lists"}