actions / upload-release-asset

An Action to upload a release asset via the GitHub Release API
MIT License
688 stars 190 forks source link

Undocumented input parameters #50

Open Bilge opened 4 years ago

Bilge commented 4 years ago

The only documented input parameter is upload_url, but the example also specifies asset_path, asset_name and asset_content_type. Where do these come from and how can they possibly be valid if they don't exist as part of the action or the underlying API?

weibeld commented 4 years ago

Furthermore, all of these undocumented input parameters (asset_path, asset_name, and asset_content_type) are required. If you don't specify them in the with clause, you get an error such as the following during the run:

##[error]Input required and not supplied: asset_content_type

So, it would be really good to document these parameters.

xeruf commented 4 years ago

furthermore, asset_name should simply default to the name of the input file?

litetex commented 4 years ago

More detailed descriptions are also available in the action.yml: https://github.com/actions/upload-release-asset/blob/main/action.yml