Add config file support and dry run option (lucacome#299)

Author: lucacome

.github/workflows/test-workflow.yml

@@ -39,3 +39,39 @@ jobs:
           echo "Release URL: ${{ steps.draft-release.outputs.release-url }}"
           echo "Release ID: ${{ steps.draft-release.outputs.release-id }}"
           echo "Release Sections: ${{ steps.draft-release.outputs.release-sections }}"
+
+  test-dry-run-config:
+      runs-on: ubuntu-latest
+      steps:
+        - uses: actions/checkout@v4
+        - uses: ./
+          id: draft-release
+          with:
+            config-path: .github/release-notes.yml
+            dry-run: true
+            variables: |
+              helm-chart=v0.1.1
+              foo=bar
+              my-variable=My Variable
+            notes-header: |
+              ## Welcome to the {{version}} release of Draft Release
+                The previous release was {{previous-version}}.
+                This is some text to welcome you to the release {{version-number}}.
+              ## Helm Chart
+                The Helm Chart version for this release is {{helm-chart}}.
+              ## My Variable
+                The value of my variable is {{my-variable}}.
+            notes-footer: |
+              ## Upgrade
+              - For Docker, use the {{version}} image from Docker Hub.
+              - For Binaries use the {{version-number}} release from GitHub.
+              - For Helm Chart, use the {{helm-chart}} version.
+              - For foo use the {{foo}} version.
+
+        - run: |
+            echo "Version: ${{ steps.draft-release.outputs.version }}"
+            echo "Previous Version: ${{ steps.draft-release.outputs.previous-version }}"
+            echo "Release Notes: ${{ steps.draft-release.outputs.release-notes }}"
+            echo "Release URL: ${{ steps.draft-release.outputs.release-url }}"
+            echo "Release ID: ${{ steps.draft-release.outputs.release-id }}"
+            echo "Release Sections: ${{ steps.draft-release.outputs.release-sections }}"

__tests__/notes.test.ts

@@ -82,6 +82,8 @@ describe('generateReleaseNotes', () => {
       variables: ['foo=bar', 'baz=qux'],
       collapseAfter: 0,
       publish: false,
+      configPath: '.github/release.yml',
+      dryRun: false,
     }
     const releaseData = {
       releases: [],
@@ -119,6 +121,8 @@ describe('generateReleaseNotes', () => {
       variables: [],
       collapseAfter: 3,
       publish: false,
+      configPath: '.github/release.yml',
+      dryRun: false,
     }
 
     const releaseData = {

__tests__/release.test.ts

@@ -140,6 +140,8 @@ describe('createOrUpdateRelease', () => {
     variables: [],
     collapseAfter: 0,
     publish: false,
+    configPath: '.github/release.yml',
+    dryRun: false,
   }
   beforeEach(() => {
     jest.clearAllMocks()

__tests__/version.test.ts

@@ -12,6 +12,8 @@ describe('getVersionIncrease', () => {
     variables: [],
     collapseAfter: 0,
     publish: false,
+    configPath: '.github/release.yml',
+    dryRun: false,
   }
 
   const releaseData = {

action.yml

@@ -34,6 +34,14 @@ inputs:
     description: 'Whether to publish the release'
     default: 'false'
     required: false
+  config-path:
+    description: 'Path to the configuration file'
+    default: '.github/release.yml'
+    required: false
+  dry-run:
+    description: 'Whether to run the action without creating a release'
+    default: 'false'
+    required: false
 outputs:
   version:
     description: 'The version of the release'

dist/index.js

@@ -10,6 +10,8 @@ export interface Inputs {
   variables: string[]
   collapseAfter: number
   publish: boolean
+  configPath: string
+  dryRun: boolean
 }
 
 export function getInputs(): Inputs {
@@ -22,5 +24,7 @@ export function getInputs(): Inputs {
     variables: Util.getInputList('variables'),
     collapseAfter: parseInt(core.getInput('collapse-after'), 10),
     publish: core.getBooleanInput('publish'),
+    configPath: core.getInput('config-path'),
+    dryRun: core.getBooleanInput('dry-run'),
   }
 }

dist/index.js.map

@@ -46,6 +46,7 @@ async function run(): Promise<void> {
     core.setOutput('version', releaseData.nextRelease)
 
     // create or update release
+
     await createOrUpdateRelease(client, inputs, releaseData)
   } catch (error) {
     if (error instanceof Error) core.setFailed(error.message)

src/context.ts

@@ -21,6 +21,7 @@ export async function generateReleaseNotes(
   const context = github.context
   const latestRelease = releaseData.latestRelease
   const nextRelease = releaseData.nextRelease
+  const configPath = inputs.configPath
   let body = ''
   let sections: SectionData = {}
 
@@ -30,6 +31,7 @@ export async function generateReleaseNotes(
       tag_name: nextRelease,
       previous_tag_name: semver.gt(latestRelease, '0.0.0') ? latestRelease : '',
       target_commitish: releaseData.branch,
+      configuration_file_path: configPath,
     })
 
     body = notes.data.body
@@ -49,7 +51,7 @@ export async function generateReleaseNotes(
       'previous-version-number': latestRelease.replace('v', ''),
       ...variables,
     }
-    const categories = await getCategories()
+    const categories = await getCategories(inputs)
     sections = await splitMarkdownSections(body, categories)
 
     body = await collapseSections(body, sections, categories, inputs.collapseAfter)

src/main.ts

@@ -87,23 +87,26 @@ export async function createOrUpdateRelease(
   core.debug(`releaseData.branch: ${releaseData.branch}`)
   const newReleaseNotes = await generateReleaseNotes(client, inputs, releaseData)
 
-  const releaseParams = {
-    ...context.repo,
-    tag_name: nextRelease,
-    name: nextRelease,
-    target_commitish: releaseData.branch,
-    body: newReleaseNotes,
-    draft: draft,
-  }
+  let response
+  if (!inputs.dryRun) {
+    const releaseParams = {
+      ...context.repo,
+      tag_name: nextRelease,
+      name: nextRelease,
+      target_commitish: releaseData.branch,
+      body: newReleaseNotes,
+      draft: draft,
+    }
 
-  const response = await (releaseDraft === undefined
-    ? client.rest.repos.createRelease({
-        ...releaseParams,
-      })
-    : client.rest.repos.updateRelease({
-        ...releaseParams,
-        release_id: releaseDraft.id,
-      }))
+    response = await (releaseDraft === undefined
+      ? client.rest.repos.createRelease({
+          ...releaseParams,
+        })
+      : client.rest.repos.updateRelease({
+          ...releaseParams,
+          release_id: releaseDraft.id,
+        }))
+  }
 
   const separator = '----------------------------------'
   core.startGroup(`${releaseDraft === undefined ? 'Create' : 'Update'} release draft for ${nextRelease}`)
@@ -112,13 +115,13 @@ export async function createOrUpdateRelease(
   core.info(separator)
   core.info(`releaseNotes: ${newReleaseNotes}`)
   core.info(separator)
-  core.info(`releaseURL: ${response.data?.html_url}`)
+  core.info(`releaseURL: ${response?.data?.html_url}`)
   core.info(separator)
   core.debug(`releaseDraft: ${JSON.stringify(releaseDraft, null, 2)}`)
-  core.debug(`${releaseDraft === undefined ? 'create' : 'update'}Release: ${JSON.stringify(response.data, null, 2)}`)
+  core.debug(`${releaseDraft === undefined ? 'create' : 'update'}Release: ${JSON.stringify(response?.data, null, 2)}`)
   core.endGroup()
 
   core.setOutput('release-notes', newReleaseNotes?.trim())
-  core.setOutput('release-id', response.data?.id)
-  core.setOutput('release-url', response.data?.html_url?.trim())
+  core.setOutput('release-id', response?.data?.id)
+  core.setOutput('release-url', response?.data?.html_url?.trim())
 }

src/notes.ts

@@ -38,8 +38,8 @@ export interface Category {
   labels: string[]
 }
 
-export async function getCategories(): Promise<Category[]> {
-  const content = await fsPromises.readFile('.github/release.yml', 'utf8')
+export async function getCategories(inputs: Inputs): Promise<Category[]> {
+  const content = await fsPromises.readFile(inputs.configPath, 'utf8')
   const doc = yaml.load(content) as ReleaseYAML
   return doc.changelog.categories.map((category) => {
     return {
@@ -50,11 +50,11 @@ export async function getCategories(): Promise<Category[]> {
 }
 
 // function that returns tile for matching label
-async function getTitleForLabel(label: string): Promise<string> {
+async function getTitleForLabel(inputs: Inputs, label: string): Promise<string> {
   if (label === '') {
     return ''
   }
-  const categories = await getCategories()
+  const categories = await getCategories(inputs)
   const category = categories.find((category) => category.labels.includes(label))
   if (category === undefined) {
     return ''
@@ -64,8 +64,8 @@ async function getTitleForLabel(label: string): Promise<string> {
 
 // function getVersionIncrease returns the version increase based on the labels. Major, minor, patch
 export async function getVersionIncrease(releaseData: ReleaseData, inputs: Inputs, notes: string): Promise<string> {
-  const majorTitle = await getTitleForLabel(inputs.majorLabel)
-  const minorTitle = await getTitleForLabel(inputs.minorLabel)
+  const majorTitle = await getTitleForLabel(inputs, inputs.majorLabel)
+  const minorTitle = await getTitleForLabel(inputs, inputs.minorLabel)
   const version = parseNotes(notes, majorTitle, minorTitle) as semver.ReleaseType
 
   return semver.inc(releaseData.latestRelease, version) || ''