Mike Penz
d66aa0a4e5
- FIX https://github.com/mikepenz/release-changelog-builder-action/issues/141 - this is not fully supported and not documented as it lacks big amounts of the features we know and love - npm install - recompile dist
49 lines
2.2 KiB
YAML
49 lines
2.2 KiB
YAML
name: 'Release Changelog Builder'
|
|
description: 'A GitHub action that builds your release notes / changelog fast, easy and exactly the way you want.'
|
|
author: 'Mike Penz'
|
|
branding:
|
|
icon: 'award'
|
|
color: 'green'
|
|
inputs:
|
|
configuration:
|
|
description: 'Defines the relative path to the configuration file.'
|
|
path:
|
|
description: 'Defines the directory the repo is located in (checkout directory)'
|
|
owner:
|
|
description: 'Defines the owner of the repository to create the changelog for'
|
|
repo:
|
|
description: 'Defines the repository to create the changelog for'
|
|
fromTag:
|
|
description: 'Defines the previous tag to compare against'
|
|
toTag:
|
|
description: 'Defines the newly tag created'
|
|
ignorePreReleases:
|
|
description: 'Defines if the action will only use full releases to compare against (Only used if fromTag is not defined). E.g. for 1.0.1... 1.0.0-rc02 <- ignore, 1.0.0 <- pick'
|
|
default: "false"
|
|
failOnError:
|
|
description: 'Defines if the action should result in a build failure, if an error was discovered'
|
|
default: "false"
|
|
commitMode:
|
|
description: 'Enables a `light` commit based mode. This mode generates changelogs based on the commits. Please note that this is not officially supported, and lacks a lot of features only possible with PRs.'
|
|
default: "false"
|
|
outputFile:
|
|
description: 'If defined, the changelog will get written to this file. (relative to the checkout dir)'
|
|
token:
|
|
description: 'Defines the token to use to execute the git API requests with, uses `env.GITHUB_TOKEN` by default'
|
|
outputs:
|
|
changelog:
|
|
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'
|