aws-actions / aws-cloudformation-github-deploy

Deploys AWS CloudFormation Stacks
MIT License
251 stars 121 forks source link

Mistake in documentation for parameter-overrides #58

Closed aleksy-zalenski closed 1 year ago

aleksy-zalenski commented 3 years ago

In the documentation of parameters for this github action there is a mistake for specifying parameter-overrides from a file. For some reason the documentation suggest the following format: (e.g. file://file://${{ github.workspace }}/variables.json) where the file:// is duplicated, when in fact the following format works: (e.g. file://${{ github.workspace }}/variables.json).

It is very confusing, so it would be good to fix that.

Suggested fix:

description: 'The parameters to override in the stack inputs. You can pass a comma-delimited list or a file URL. Comma-delimited list has each entry formatted as <ParameterName>=<ParameterValue>. A JSON file can be a local file with a "file://" prefix or remote URL (e.g. file://${{ github.workspace }}/variables.json or http://example.com/variables.json). A local file needs to be specified with an absolute path to it. The file should look like: [ { "ParameterKey": "KeyPairName", "ParameterValue": "MyKey" }]'

Reference to the discussed line: https://github.com/aws-actions/aws-cloudformation-github-deploy/blob/e52fd9690fef4df4a8d5086099f6fcb42207c75a/action.yml#L18

kddejong commented 1 year ago

Resolved in the primary branch and waiting on release.