From c18a89eed164e4414b30da38013938f498abef11 Mon Sep 17 00:00:00 2001 From: Tycho Bokdam Date: Tue, 28 Apr 2020 17:14:52 +0200 Subject: [PATCH] feat: Added the option to provide the location of the packge.json --- README.md | 6 ++++-- action.yml | 5 +++++ src/helpers/packageJson.js | 3 ++- src/index.js | 6 ++++++ 4 files changed, 17 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a2b951c..2f3f36c 100644 --- a/README.md +++ b/README.md @@ -10,13 +10,14 @@ This action will bump version, tag commit and generate a changelog with conventi - **Optional** `tag-prefix`: Prefix for the git tags. Default `v`. - **Optional** `output-file`: File to output the changelog to. Default `CHANGELOG.md`. - **Optional** `release-count`: Number of releases to preserve in changelog. Default `5`, use `0` to regenerate all. +- **Optional** `package-json`: The path to the package.json to use. Default `./package.json`. ## Example usages Uses all the defaults ```yaml - name: Conventional Changelog Action - uses: TriPSs/conventional-changelog-action@v2.0.1 + uses: TriPSs/conventional-changelog-action@v2.1.0 with: github-token: ${{ secrets.github_token }} ``` @@ -24,7 +25,7 @@ Uses all the defaults Overwrite everything ```yaml - name: Conventional Changelog Action - uses: TriPSs/conventional-changelog-action@v2.0.1 + uses: TriPSs/conventional-changelog-action@v2.1.0 with: github-token: ${{ secrets.github_token }} git-message: 'chore(release): {version}' @@ -32,4 +33,5 @@ Overwrite everything tag-prefix: 'v' output-file: 'CHANGELOG.md' release-count: '5' + package-json: './package.json' ``` diff --git a/action.yml b/action.yml index c58c405..f329101 100644 --- a/action.yml +++ b/action.yml @@ -38,3 +38,8 @@ inputs: description: 'Number of releases to preserve in changelog' default: '5' required: false + + package-json: + description: 'The path to the package.json to use' + default: './package.json' + required: false diff --git a/src/helpers/packageJson.js b/src/helpers/packageJson.js index cf52238..037f446 100644 --- a/src/helpers/packageJson.js +++ b/src/helpers/packageJson.js @@ -1,7 +1,8 @@ const path = require('path') const fs = require('fs') +const core = require('@actions/core') -const packageJsonLoc = path.resolve('./', 'package.json') +const packageJsonLoc = path.resolve(core.getInput('package-json')) module.exports = { diff --git a/src/index.js b/src/index.js index f846983..d50d6d2 100644 --- a/src/index.js +++ b/src/index.js @@ -12,8 +12,14 @@ async function run() { const preset = core.getInput('preset') const outputFile = core.getInput('output-file') const releaseCount = core.getInput('release-count') + const packageJsonToUse = core.getInput('package-json') core.info(`Using "${preset}" preset`) + core.info(`Using "${commitMessage}" as commit message`) + core.info(`Using "${releaseCount}" release count`) + core.info(`Using "${packageJsonToUse}"`) + core.info(`Using "${tagPrefix}" as tag prefix`) + core.info(`Using "${outputFile}" as output file`) conventionalRecommendedBump({ preset }, async(error, recommendation) => { if (error) {