Implement changelog writer

Author: silvanocerza

__tests__/changelog.test.ts

@@ -0,0 +1,43 @@
+import * as io from '@actions/io'
+import * as path from 'path'
+import * as fs from 'fs'
+import {Settings} from '../src/settings'
+import {Changelog} from '../src/changelog'
+import {GitCommit} from '../src/git'
+import {TEST_DIR} from './common'
+
+describe('Changelog', () => {
+  afterAll(() => {
+    io.rmRF(TEST_DIR)
+  })
+
+  it('Verifies changelog is saved to file', async () => {
+    const settings = {} as Settings
+    settings.changelogFilePath = path.join(TEST_DIR, 'CHANGELOG.md')
+
+    // Verifies path doesn't exists
+    expect(fs.existsSync(TEST_DIR)).toBe(false)
+
+    const gitLog: GitCommit[] = [
+      new GitCommit('295b513', 'Third commit'),
+      new GitCommit('0dad212', 'Second commit'),
+      new GitCommit('80913ba', 'First commit')
+    ]
+    const changelog = new Changelog(settings)
+    changelog.write(gitLog)
+
+    // Read created CHANGELOG.md
+    const fileContent: string = fs.readFileSync(settings.changelogFilePath).toString()
+
+    const expectedFileContent: string = [
+      '# Changelog',
+      '295b513 Third commit',
+      '0dad212 Second commit',
+      '80913ba First commit'
+    ].join('\n')
+
+    // Verifies file is created and contains expected data
+    expect(fs.existsSync(settings.changelogFilePath)).toBe(true)
+    expect(fileContent).toEqual(expectedFileContent)
+  })
+})

jest.config.js

@@ -7,6 +7,5 @@ module.exports = {
     transform: {
       '^.+\\.ts$': 'ts-jest'
     },
-    // maxConcurrency: 1,
     verbose: true
   }

src/changelog.ts

@@ -0,0 +1,28 @@
+import * as fs from 'fs'
+import * as path from 'path'
+import * as io from '@actions/io'
+import {Settings} from './settings'
+import {GitCommit} from './git'
+
+export class Changelog {
+  private settings: Settings
+
+  constructor(settings: Settings) {
+    this.settings = settings
+  }
+
+  write(log: GitCommit[]) {
+    let lines: string[] = ['# Changelog']
+
+    log.forEach(c => {
+      lines.push(`${c.hash} ${c.message}`)
+    })
+
+    const changelogDir: string = path.parse(this.settings.changelogFilePath).dir
+    if (!fs.existsSync(changelogDir)) {
+      io.mkdirP(changelogDir)
+    }
+
+    fs.writeFileSync(this.settings.changelogFilePath, lines.join('\n'))
+  }
+}

src/git.ts

@@ -68,7 +68,7 @@ export class Git {
     res.stdout.forEach(commit => {
       const split = commit.split(' ')
       const hash = split[0]
-      const message = split.slice(1).join(' ')
+      const message = split.slice(1).join(' ').trim()
 
       if (this.settings.filterRegex && RegExp(this.settings.filterRegex).test(message)) {
         return
@@ -109,7 +109,7 @@ class GitOutput {
   exitCode = 0
 }
 
-class GitCommit {
+export class GitCommit {
   hash: string = ''
   message: string = ''
 

src/settings.ts

@@ -1,3 +1,6 @@
+import * as core from '@actions/core'
+import * as io from '@actions/io'
+
 export interface Settings {
   // TODO: DOCS
   gitPath: string
@@ -6,3 +9,13 @@ export interface Settings {
   filterRegex: string | RegExp
   changelogFilePath: string
 }
+
+export async function initSettings(): Promise<Settings> {
+  const settings = {} as Settings
+  settings.gitPath = await io.which('git', true)
+  settings.repoPath = core.getInput('path') || '.'
+  settings.tagRegex = core.getInput('tag-regex') || ''
+  settings.filterRegex = core.getInput('filter-regex') || ''
+  settings.changelogFilePath = core.getInput('changelog-file-path') || 'CHANGELOG.md'
+  return settings
+}