feat: add changelog and gh release support

Author: henrycunh

action.yml

@@ -5,6 +5,11 @@ inputs:
     github-token:
         required: true
         description: GitHub personal access token
+outputs:
+    next-version:
+        description: Next version to be released
+    release-type:
+        description: Type of release
 runs:
     using: 'node16'
     main: 'dist/index.js'

dist/index.js

@@ -1,26 +1,25 @@
 {
-    "name": "typescript-action",
-    "version": "0.0.0",
+    "name": "publish-semver-release-action",
+    "version": "0.3.0",
     "private": true,
-    "description": "TypeScript template action",
+    "description": "🚀 A GitHub action to publish a new release of the repository",
     "main": "lib/main.js",
     "scripts": {
         "build": "tsc",
         "format": "prettier --write '**/*.ts'",
         "format-check": "prettier --check '**/*.ts'",
         "lint": "eslint src/**/*.ts",
         "package": "ncc build --source-map --license licenses.txt",
+        "publish": "npm run build && npm run package",
         "test": "vitest",
         "all": "npm run build && npm run format && npm run lint && npm run package && npm test"
     },
     "repository": {
         "type": "git",
-        "url": "git+https://github.com/actions/typescript-action.git"
+        "url": "git+https://github.com/clicampo/action-publish-semver-release.git"
     },
     "keywords": [
-        "actions",
-        "node",
-        "setup"
+        "actions"
     ],
     "author": "",
     "license": "MIT",

dist/index.js.map

@@ -2,10 +2,19 @@ import { getInput } from '@actions/core'
 import { getExecOutput } from '@actions/exec'
 import { getOctokit } from '@actions/github'
 import type { Context } from '@actions/github/lib/context'
+import type { ReleaseType } from './version'
+import { getReleaseTypeFromCommitMessage } from './version'
+
+type CommitsByReleaseType = Record<ReleaseType, { message: string; url: string; author: string }[]>
+type CommitList = Awaited<
+ReturnType<
+ReturnType<typeof getOctokit>['rest']['repos']['listCommits']
+>
+>['data']
 
 const run = async(command: string) => (await getExecOutput(command)).stdout
 
-export const generateChangelog = async(context: Context) => {
+const getLastCommits = async(context: Context) => {
     const githubToken = getInput('github-token') || process.env.GH_TOKEN
     if (githubToken === '' || githubToken === undefined)
         throw new Error('GitHub token is required')
@@ -21,13 +30,73 @@ export const generateChangelog = async(context: Context) => {
         repo: context.repo.repo,
     })
 
-    // Get all commits since last tag
     const lastCommits = []
     for (const commit of commits) {
         if (commit.sha === lastTaggedCommitSha)
             break
         lastCommits.push(commit)
     }
 
-    return lastCommits.map(commit => `- ${commit.commit.message}`).join('\n')
+    return lastCommits
+}
+
+const groupCommitsByReleaseType = (commits: CommitList) => {
+    return commits
+        .map((commit) => {
+            const { message, url, author } = commit.commit
+            const type = getReleaseTypeFromCommitMessage(message)
+            return { message, type, url, author: String(author?.name) }
+        })
+        .reduce((commitsByType, commit) => {
+            if (commit.type === null)
+                return commitsByType
+            if (!(commit.type in commitsByType))
+                commitsByType[commit.type] = []
+            commitsByType[commit.type].push(commit)
+            return commitsByType
+        }, {} as (CommitsByReleaseType))
+}
+
+const formatCommitsByType = (commitsByType: CommitsByReleaseType) => {
+    let changelog = ''
+    const getCommitInfo = (commit: { message: string; url: string; author: string }) => {
+        const message = commit.message.split(':')[1].trim()
+        const scope = commit.message.match(/^(.*?): /)?.[1] ?? ''
+        const commitSha = commit.url.split('/').pop()?.slice(0, 8)
+        return { message, scope, commitSha }
+    }
+    if (commitsByType.major) {
+        changelog += `${[
+            '## ⚠️ This release introduces breaking changes',
+            '### Features',
+        ].join('\n')}\n`
+    }
+    if (commitsByType.minor) {
+        if (!commitsByType.major)
+            changelog += '### Features\n'
+
+        const featureCommits = [
+            ...(commitsByType.major || []),
+            ...(commitsByType.minor || []),
+        ]
+        for (const commit of featureCommits) {
+            const { message, scope, commitSha } = getCommitInfo(commit)
+            changelog += `- **(${scope})** ${message} ([${commitSha}](${commit.url}))\n`
+        }
+    }
+    if (commitsByType.patch) {
+        changelog += '### Bug Fixes\n'
+        for (const commit of commitsByType.patch) {
+            const { message, scope, commitSha } = getCommitInfo(commit)
+            changelog += `- **(${scope})** ${message} ([${commitSha}](${commit.url}))\n`
+        }
+    }
+
+    return changelog
+}
+
+export const generateChangelog = async(context: Context) => {
+    const lastCommits = await getLastCommits(context)
+    const commitsByType = groupCommitsByReleaseType(lastCommits)
+    return formatCommitsByType(commitsByType)
 }