Files
release-changelog-builder-a…/action.yml
T
Mike Penz d557b224ae - upgrade action to use node16 as engine
- dependency upgrades
```
    "webpack": "^5.70.0"
    "@types/jest": "^27.4.1",
    "@typescript-eslint/parser": "^5.15.0",
    "@types/node": "^17.0.21",
    "@vercel/ncc": "^0.33.3",
    "eslint": "^8.11.0",
    "eslint-plugin-jest": "^26.1.1",
    "prettier": "2.6.0",
    "typescript": "^4.6.2"
```
2022-03-16 12:55:47 +01:00

51 lines
2.3 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'
baseUrl:
description: 'Defines the base url for GitHub Enterprise authentication, uses `https://api.github.com` 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: 'node16'
main: 'dist/index.js'