joutvhu/Create Or Update Release
GitHub Action to Create Release
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stalelast commit Dec 26, 2023
- License
- MIT
Pinned Snippet
uses: joutvhu/create-release@7ca8c87c72f9518b5f4c9d987343016da346c71e # v1.0.1tags can be moved; commit SHAs can't. why a SHA?
Inputs
| name | description | required | default |
|---|---|---|---|
| owner | Owner of the repository if it is not the current one. | no | — |
| repo | Repository on which to release. Used only if you want to create the release on another repo. | no | — |
| tag_name | The name of the tag. This should come from the webhook payload, `github.GITHUB_REF` when a user pushes a new tag | yes | — |
| name | The name of the release. For example, `Release v1.0.1` | yes | — |
| body | Text describing the contents of the tag. | no | — |
| body_path | Path to file with information about the tag. | no | — |
| draft | `true` to create a draft (unpublished) release, `false` to create a published one. Default: `false` | no | false |
| prerelease | `true` to identify the release as a prerelease. `false` to identify the release as a full release. Default: `false` | no | false |
| make_latest | Indicates if the release should be the "latest" release or not. | no | true |
| target_commitish | Any branch or commit SHA the Git tag is created from, unused if the Git tag already exists. Default: SHA of current commit | no | — |
| discussion_category_name | When provided this will generate a discussion of the specified category. The category must exist otherwise this will cause the action to fail. This isn't used with draft releases | no | — |
| generate_release_notes | Indicates if release notes should be automatically generated. | no | — |
| on_release_exists | Indicate what to do if a release already exists. Options: `skip`, `update`, `update_only_unreleased`, `update_only_unreleased_or_skip`, `error` | no | skip |
| remove_assets | Indicates if existing release artifacts should be removed, Defaults to false. | no | false |
| debug | Show ouputs | no | — |
Outputs
| name | description |
|---|---|
| id | The ID of the created Release |
| node_id | The node ID |
| url | The release url |
| html_url | The URL users can navigate to in order to view the release |
| assets_url | The release assets url |
| upload_url | The URL for uploading assets to the release |
| discussion_url | The URL of discussion |
| tarball_url | The URL of tarball |
| zipball_url | The URL of zipball |
| mentions_count | The mentions count |
| name | The release name |
| tag_name | The git tag associated with the release |
| draft | Is draft |
| prerelease | Is pre-release |
| target_commitish | The release was create to which target branch |
| created_at | Created date |
| published_at | Published date |
| body | The release body |