- add support for configs to be provided from file and json

- define priority on the config json from YML, followed by file, last with the default value
  - Simplify code by merging configs right away
  - thanks for the suggestion @dtcMLOps

src/main.ts

@@ -1,6 +1,6 @@
 import * as core from '@actions/core'
 import * as github from '@actions/github'
-import {parseConfiguration, resolveConfiguration, retrieveRepositoryPath, writeOutput} from './utils'
+import {mergeConfiguration, parseConfiguration, resolveConfiguration, retrieveRepositoryPath, writeOutput} from './utils'
 import {ReleaseNotesBuilder} from './releaseNotesBuilder'
 import {Configuration} from './configuration'
 
@@ -13,18 +13,20 @@ async function run(): Promise<void> {
     const inputPath = core.getInput('path')
     const repositoryPath = retrieveRepositoryPath(inputPath)
 
-    // read in configuration file if possible
-    let configuration: Configuration | undefined = undefined
+    // read in configuration from json if possible
+    let configJson: Configuration | undefined = undefined
     const configurationJson: string = core.getInput('configurationJson', {
       trimWhitespace: true
     })
     if (configurationJson) {
-      configuration = parseConfiguration(configurationJson)
-    }
-    if (!configuration) {
-      const configurationFile: string = core.getInput('configuration')
-      configuration = resolveConfiguration(repositoryPath, configurationFile)
+      configJson = parseConfiguration(configurationJson)
     }
+    // read in the configuration from the file if possible
+    const configurationFile: string = core.getInput('configuration')
+    const configFile = resolveConfiguration(repositoryPath, configurationFile)
+
+    // merge configs, use default values from DefaultConfig on missing definition
+    const configuration = mergeConfiguration(configJson, configFile)
 
     // read in repository inputs
     const baseUrl = core.getInput('baseUrl')

src/releaseNotes.ts

@@ -1,6 +1,6 @@
 import * as core from '@actions/core'
 import {Commits, filterCommits, DiffInfo, DefaultDiffInfo} from './commits'
-import {Configuration, DefaultConfiguration} from './configuration'
+import {Configuration} from './configuration'
 import {PullRequestInfo, PullRequests} from './pullRequests'
 import {Octokit} from '@octokit/rest'
 import {buildChangelog, replaceEmptyTemplate} from './transform'
@@ -62,7 +62,7 @@ export class ReleaseNotes {
 
     if (mergedPullRequests.length === 0) {
       core.warning(`⚠️ No pull requests found`)
-      return replaceEmptyTemplate(this.options.configuration.empty_template || DefaultConfiguration.empty_template, this.options)
+      return replaceEmptyTemplate(this.options.configuration.empty_template, this.options)
     }
 
     core.startGroup('📦 Build changelog')
@@ -105,7 +105,7 @@ export class ReleaseNotes {
     let fromDate = firstCommit.date
     const toDate = lastCommit.date
 
-    const maxDays = configuration.max_back_track_time_days || DefaultConfiguration.max_back_track_time_days
+    const maxDays = configuration.max_back_track_time_days
     const maxFromDate = toDate.clone().subtract(maxDays, 'days')
     if (maxFromDate.isAfter(fromDate)) {
       core.info(`⚠️ Adjusted 'fromDate' to go max ${maxDays} back`)
@@ -115,17 +115,11 @@ export class ReleaseNotes {
     core.info(`ℹ️ Fetching PRs between dates ${fromDate.toISOString()} to ${toDate.toISOString()} for ${owner}/${repo}`)
 
     const pullRequestsApi = new PullRequests(octokit)
-    const pullRequests = await pullRequestsApi.getBetweenDates(
-      owner,
-      repo,
-      fromDate,
-      toDate,
-      configuration.max_pull_requests || DefaultConfiguration.max_pull_requests
-    )
+    const pullRequests = await pullRequestsApi.getBetweenDates(owner, repo, fromDate, toDate, configuration.max_pull_requests)
 
     core.info(`ℹ️ Retrieved ${pullRequests.length} PRs for ${owner}/${repo} in date range from API`)
 
-    const prCommits = filterCommits(commits, configuration.exclude_merge_branches || DefaultConfiguration.exclude_merge_branches)
+    const prCommits = filterCommits(commits, configuration.exclude_merge_branches)
 
     core.info(`ℹ️ Retrieved ${prCommits.length} release commits for ${owner}/${repo}`)
 
@@ -144,11 +138,7 @@ export class ReleaseNotes {
     let allPullRequests = mergedPullRequests
     if (includeOpen) {
       // retrieve all open pull requests
-      const openPullRequests = await pullRequestsApi.getOpen(
-        owner,
-        repo,
-        configuration.max_pull_requests || DefaultConfiguration.max_pull_requests
-      )
+      const openPullRequests = await pullRequestsApi.getOpen(owner, repo, configuration.max_pull_requests)
 
       core.info(`ℹ️ Retrieved ${openPullRequests.length} open PRs for ${owner}/${repo}`)
 
@@ -159,7 +149,7 @@ export class ReleaseNotes {
     }
 
     // retrieve base branches we allow
-    const baseBranches = configuration.base_branches || DefaultConfiguration.base_branches
+    const baseBranches = configuration.base_branches
     const baseBranchPatterns = baseBranches.map(baseBranch => {
       return new RegExp(baseBranch.replace('\\\\', '\\'), 'gu')
     })
@@ -216,7 +206,7 @@ export class ReleaseNotes {
       return [diffInfo, []]
     }
 
-    const prCommits = filterCommits(commits, configuration.exclude_merge_branches || DefaultConfiguration.exclude_merge_branches)
+    const prCommits = filterCommits(commits, configuration.exclude_merge_branches)
 
     core.info(`ℹ️ Retrieved ${prCommits.length} commits for ${owner}/${repo}`)
 

src/releaseNotesBuilder.ts

@@ -1,5 +1,5 @@
 import * as core from '@actions/core'
-import {Configuration, DefaultConfiguration} from './configuration'
+import {Configuration} from './configuration'
 import {Octokit} from '@octokit/rest'
 import {ReleaseNotes} from './releaseNotes'
 import {Tags} from './tags'
@@ -77,8 +77,8 @@ export class ReleaseNotesBuilder {
       this.fromTag,
       this.toTag,
       this.ignorePreReleases,
-      this.configuration.max_tags_to_fetch || DefaultConfiguration.max_tags_to_fetch,
-      this.configuration.tag_resolver || DefaultConfiguration.tag_resolver
+      this.configuration.max_tags_to_fetch,
+      this.configuration.tag_resolver
     )
 
     let thisTag = tagRange.to

src/transform.ts

@@ -1,5 +1,5 @@
 import * as core from '@actions/core'
-import {Category, Configuration, DefaultConfiguration, Extractor, Placeholder, Transformer} from './configuration'
+import {Category, Configuration, Extractor, Placeholder, Transformer} from './configuration'
 import {CommentInfo, EMPTY_COMMENT_INFO, PullRequestInfo, sortPullRequests} from './pullRequests'
 import {ReleaseNotesOptions} from './releaseNotes'
 import {DiffInfo} from './commits'
@@ -18,7 +18,7 @@ const EMPTY_MAP = new Map<string, string>()
 export function buildChangelog(diffInfo: DiffInfo, prs: PullRequestInfo[], options: ReleaseNotesOptions): string {
   // sort to target order
   const config = options.configuration
-  const sort = config.sort || DefaultConfiguration.sort
+  const sort = config.sort
   prs = sortPullRequests(prs, sort)
   core.info(`ℹ️ Sorted all pull requests ascending: ${JSON.stringify(sort)}`)
 
@@ -73,21 +73,15 @@ export function buildChangelog(diffInfo: DiffInfo, prs: PullRequestInfo[], optio
   const transformedMap = new Map<PullRequestInfo, string>()
   // convert PRs to their text representation
   for (const pr of prs) {
-    transformedMap.set(
-      pr,
-      transform(
-        fillPrTemplate(pr, config.pr_template || DefaultConfiguration.pr_template, placeholders, placeholderPrMap, config),
-        validatedTransformers
-      )
-    )
+    transformedMap.set(pr, transform(fillPrTemplate(pr, config.pr_template, placeholders, placeholderPrMap, config), validatedTransformers))
   }
   core.info(`ℹ️ Used ${validatedTransformers.length} transformers to adjust message`)
   core.info(`✒️ Wrote messages for ${prs.length} pull requests`)
 
   // bring PRs into the order of categories
   const categorized = new Map<Category, string[]>()
-  const categories = config.categories || DefaultConfiguration.categories
-  const ignoredLabels = config.ignore_labels || DefaultConfiguration.ignore_labels
+  const categories = config.categories
+  const ignoredLabels = config.ignore_labels
 
   for (const category of categories) {
     categorized.set(category, [])
@@ -252,7 +246,7 @@ export function buildChangelog(diffInfo: DiffInfo, prs: PullRequestInfo[], optio
   placeholderMap.set('COMMITS', diffInfo.commits.toString())
   fillAdditionalPlaceholders(options, placeholderMap)
 
-  let transformedChangelog = config.template || DefaultConfiguration.template
+  let transformedChangelog = config.template
   transformedChangelog = replacePlaceholders(transformedChangelog, EMPTY_MAP, placeholderMap, placeholders, placeholderPrMap, config)
   transformedChangelog = replacePrPlaceholders(transformedChangelog, placeholderPrMap, config)
   transformedChangelog = cleanupPrPlaceholders(transformedChangelog, placeholders)
@@ -453,7 +447,7 @@ function transform(filled: string, transformers: RegexTransformer[]): string {
 }
 
 function validateTransformers(specifiedTransformers: Transformer[]): RegexTransformer[] {
-  const transformers = specifiedTransformers || DefaultConfiguration.transformers
+  const transformers = specifiedTransformers
   return transformers
     .map(transformer => {
       return validateTransformer(transformer)

src/utils.ts

@@ -84,6 +84,31 @@ export function parseConfiguration(config: string): Configuration | undefined {
   }
 }
 
+/**
+ * Merges the configurations, will fallback to the DefaultConfiguration value
+ */
+export function mergeConfiguration(jc?: Configuration, fc?: Configuration): Configuration {
+  return {
+    max_tags_to_fetch: jc?.max_tags_to_fetch || fc?.max_tags_to_fetch || DefaultConfiguration.max_tags_to_fetch,
+    max_pull_requests: jc?.max_pull_requests || fc?.max_pull_requests || DefaultConfiguration.max_pull_requests,
+    max_back_track_time_days: jc?.max_back_track_time_days || fc?.max_back_track_time_days || DefaultConfiguration.max_back_track_time_days,
+    exclude_merge_branches: jc?.exclude_merge_branches || fc?.exclude_merge_branches || DefaultConfiguration.exclude_merge_branches,
+    sort: jc?.sort || fc?.sort || DefaultConfiguration.sort,
+    template: jc?.template || fc?.template || DefaultConfiguration.template,
+    pr_template: jc?.pr_template || fc?.pr_template || DefaultConfiguration.pr_template,
+    empty_template: jc?.empty_template || fc?.empty_template || DefaultConfiguration.empty_template,
+    categories: jc?.categories || fc?.categories || DefaultConfiguration.categories,
+    ignore_labels: jc?.ignore_labels || fc?.ignore_labels || DefaultConfiguration.ignore_labels,
+    label_extractor: jc?.label_extractor || fc?.label_extractor || DefaultConfiguration.label_extractor,
+    duplicate_filter: jc?.duplicate_filter || fc?.duplicate_filter || DefaultConfiguration.duplicate_filter,
+    transformers: jc?.transformers || fc?.transformers || DefaultConfiguration.transformers,
+    tag_resolver: jc?.tag_resolver || fc?.tag_resolver || DefaultConfiguration.tag_resolver,
+    base_branches: jc?.base_branches || fc?.base_branches || DefaultConfiguration.base_branches,
+    custom_placeholders: jc?.custom_placeholders || fc?.custom_placeholders || DefaultConfiguration.custom_placeholders,
+    trim_values: jc?.trim_values || fc?.trim_values || DefaultConfiguration.trim_values
+  }
+}
+
 /**
  * Checks if a given directory exists
  */