- update documentation about outputs from the action

This commit is contained in:
Mike Penz
2020-10-29 11:24:08 +01:00
parent 29ba2a9980
commit 9fed378411
+11 -1
View File
@@ -27,7 +27,17 @@ inputs:
description: 'Defines the token to use to execute the git API requests with, uses `env.GITHUB_TOKEN` by default'
outputs:
changelog:
description: Returns the generated changelog as markdown.
description: The built release changelog built from the merged pull requests
owner:
description: Specifies the owner of the repository processed
repo:
description: Describes the repository name, which was processed
fromTag:
description: Defines the `fromTag` which describes the lower bound to process pull requests for
toTag:
description: Defines the `toTag` which describes the upper bound to process pull request for
failed:
description: Defines if there was an issue with the action run, and the changelog may not have been generated correctly. [true, false]
runs:
using: 'node12'
main: 'dist/index.js'