From 37bdaa9caca478a970ff0b920ed3580177a7b3bc Mon Sep 17 00:00:00 2001 From: Bob Evans Date: Tue, 2 Apr 2024 10:02:38 -0400 Subject: [PATCH] chore: Apply suggestions from code review Co-authored-by: James Sumners --- .github/workflows/prep-release.yml | 2 +- bin/prepare-release.js | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/prep-release.yml b/.github/workflows/prep-release.yml index f845ee2ef8..c84268d6d4 100644 --- a/.github/workflows/prep-release.yml +++ b/.github/workflows/prep-release.yml @@ -18,7 +18,7 @@ on: type: string required: false changelog_json: - description: Whether or not it should generate a changelog.json(should only be for node-newrelic) + description: Whether or not it should generate a changelog.json (should only be for node-newrelic) type: boolean required: false diff --git a/bin/prepare-release.js b/bin/prepare-release.js index 4e6a2866e8..d769472467 100644 --- a/bin/prepare-release.js +++ b/bin/prepare-release.js @@ -325,7 +325,7 @@ async function generateReleaseNotes(owner, repo) { * @param {string} params.newVersion version to be published * @param {string} params.markdownChangelog filepath of markdown changelog * @param {boolean} params.generateJsonChangelog indicator if it should update changelog.json - * @returns {array} generate data of markdown and json + * @returns {object[]} generate data of markdown and json */ async function generateConventionalReleaseNotes({ owner,