Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Update README.md add input and output attributes into a table #188

Merged
merged 1 commit into from
Mar 31, 2022
Merged

docs: Update README.md add input and output attributes into a table #188

merged 1 commit into from
Mar 31, 2022

Conversation

ederfmatos
Copy link
Contributor

@ederfmatos ederfmatos commented Mar 25, 2022

Release Action

This action will create a GitHub release and optionally upload an artifact to it.

Action Inputs

Input name Description Required Default Value
allowUpdates An optional flag which indicates if we should update a release if it already exists. Defaults to false. false ""
artifactErrorsFailBuild An optional flag which indicates if artifact read or upload errors should fail the build. false ""
artifact An optional set of paths representing artifacts to upload to the release. This may be a single path or a comma delimited list of paths (or globs) false ""
artifacts An optional set of paths representing artifacts to upload to the release. This may be a single path or a comma delimited list of paths (or globs) false ""
artifactContentType The content type of the artifact. Defaults to raw false ""
body An optional body for the release. false ""
bodyFile An optional body file for the release. This should be the path to the file false ""
commit An optional commit reference. This will be used to create the tag if it does not exist. false ""
discussionCategory 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 false false
draft Optionally marks this release as a draft release. Set to true to enable. false ""
generateReleaseNotes Indicates if release notes should be automatically generated. false false
name An optional name for the release. If this is omitted the tag will be used. false ""
omitBody Indicates if the release body should be omitted. false false
omitBodyDuringUpdate Indicates if the release body should be omitted during updates. The body will still be applied for newly created releases. This will preserve the existing body during updates. false false
omitName Indicates if the release name should be omitted. false false
omitNameDuringUpdate Indicates if the release name should be omitted during updates. The name will still be applied for newly created releases. This will preserve the existing name during updates. false false
omitPrereleaseDuringUpdate Indicates if the prerelease flag should be omitted during updates. The prerelease flag will still be applied for newly created releases. This will preserve the existing prerelease state during updates. false false
owner Optionally specify the owner of the repo where the release should be generated. Defaults to current repo'sowner. false ""
prerelease Optionally marks this release as prerelease. Set to true to enable. false ""
removeArtifacts Indicates if existing release artifacts should be removed. false false
replacesArtifacts Indicates if existing release artifacts should be replaced. false true
repo Optionally specify the repo where the release should be generated. false current repo
tag An optional tag for the release. If this is omitted the git ref will be used (if it is a tag). false ""
token The GitHub token. Typically, this will be ${{ secrets.GITHUB_TOKEN }}. If you are using a personal access token it should have access to the repo scope. false github.token

Action Outputs

Output name Description
id The identifier of the created release.
html_url The HTML URL of the release.
upload_url The URL for uploading assets to the release.

Copy link
Owner

@ncipollo ncipollo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR, this is great! I'm going to prune out the deprecated inputs, but I'll do that off of main.

@ncipollo ncipollo merged commit 918a7af into ncipollo:main Mar 31, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants