add prettier and warning for invalid release types

Author: Moritz Schmitz von Hülst

.github/workflows/test.yml

@@ -13,4 +13,5 @@ jobs:
       - uses: actions/checkout@v2
       - run: npm ci
       - run: npm run test
+      - run: npm run check
       - run: npm run build

.prettierignore

@@ -0,0 +1,7 @@
+/.github/
+/.vscode/
+/docs/
+/*.json
+/*.js
+/*.yml
+/*.md

.prettierrc.json

@@ -0,0 +1,4 @@
+{
+  "singleQuote": true,
+  "parser": "typescript"
+}

package-lock.json

@@ -6,7 +6,8 @@
   "main": "lib/index.js",
   "scripts": {
     "build": "tsc",
-    "test": "jest --testTimeout 10000"
+    "test": "jest --testTimeout 10000",
+    "check": "prettier --check ."
   },
   "repository": {
     "type": "git",
@@ -33,6 +34,7 @@
     "jest": "^26.6.3",
     "jest-circus": "^26.6.3",
     "js-yaml": "^3.14.0",
+    "prettier": "2.1.2",
     "ts-jest": "^26.4.4",
     "typescript": "^3.8.3"
   }

package.json

@@ -1,14 +1,14 @@
-import { context, GitHub } from "@actions/github";
-import * as core from "@actions/core";
-import { Octokit } from "@octokit/rest";
+import { context, GitHub } from '@actions/github';
+import * as core from '@actions/core';
+import { Octokit } from '@octokit/rest';
 
 let octokitSingleton;
 
 export function getOctokitSingleton() {
   if (octokitSingleton) {
     return octokitSingleton;
   }
-  const githubToken = core.getInput("github_token");
+  const githubToken = core.getInput('github_token');
   octokitSingleton = new GitHub(githubToken);
   return octokitSingleton;
 }
@@ -30,7 +30,7 @@ export async function compareCommits(sha: string) {
   const commits = await octokit.repos.compareCommits({
     ...context.repo,
     base: sha,
-    head: "HEAD",
+    head: 'HEAD',
   });
 
   return commits.data.commits;
@@ -52,7 +52,7 @@ export async function createTag(
       tag: newTag,
       message: newTag,
       object: GITHUB_SHA,
-      type: "commit",
+      type: 'commit',
     });
   }
 

src/github.ts

@@ -50,13 +50,13 @@ export default async () => {
       .some((branch) => currentBranch.match(branch));
     const isPrerelease = !isReleaseBranch && isPreReleaseBranch;
 
-    const identifier = appendToPreReleaseTag ? appendToPreReleaseTag : currentBranch;
+    const identifier = appendToPreReleaseTag
+      ? appendToPreReleaseTag
+      : currentBranch;
+
     const validTags = await getValidTags();
     const latestTag = getLatestTag(validTags);
-    const latestPrereleaseTag = getLatestPrereleaseTag(
-      validTags,
-      identifier,
-    );
+    const latestPrereleaseTag = getLatestPrereleaseTag(validTags, identifier);
 
     const commits = await getCommits(latestTag.commit.sha);
 
@@ -72,7 +72,7 @@ export default async () => {
         previousTag = parse(
           gte(latestTag.name, latestPrereleaseTag.name)
             ? latestTag.name
-            : latestPrereleaseTag.name,
+            : latestPrereleaseTag.name
         );
       }
 
@@ -86,29 +86,27 @@ export default async () => {
 
       let bump = await analyzeCommits(
         { releaseRules: mappedReleaseRules },
-        { commits, logger: { log: console.info.bind(console) } },
+        { commits, logger: { log: console.info.bind(console) } }
       );
 
       if (!bump && defaultBump === 'false') {
-        core.debug('No commit specifies the version bump. Skipping the tag creation.');
+        core.debug(
+          'No commit specifies the version bump. Skipping the tag creation.'
+        );
         return;
       }
 
       // If somebody uses custom release rules on a prerelease branch they might create a 'preprepatch' bump.
       const preReg = /^pre/;
       if (isPrerelease && preReg.test(bump)) {
-        bump = bump.replace(preReg,'');
+        bump = bump.replace(preReg, '');
       }
 
       const releaseType: ReleaseType = isPrerelease
         ? `pre${bump || defaultBump}`
         : bump || defaultBump;
 
-      const incrementedVersion = inc(
-        previousTag,
-        releaseType,
-        identifier,
-      );
+      const incrementedVersion = inc(previousTag, releaseType, identifier);
 
       if (!incrementedVersion) {
         core.setFailed('Could not increment version.');
@@ -140,14 +138,14 @@ export default async () => {
         },
         lastRelease: { gitTag: latestTag.name },
         nextRelease: { gitTag: newTag, version: newVersion },
-      },
+      }
     );
     core.info(`Changelog is ${changelog}.`);
     core.setOutput('changelog', changelog);
 
     if (!isReleaseBranch && !isPreReleaseBranch) {
       core.info(
-        'This branch is neither a release nor a pre-release branch. Skipping the tag creation.',
+        'This branch is neither a release nor a pre-release branch. Skipping the tag creation.'
       );
       return;
     }
@@ -166,4 +164,4 @@ export default async () => {
   } catch (error) {
     core.setFailed(error.message);
   }
-}
+};

src/main.ts

@@ -1,8 +1,8 @@
-import * as core from "@actions/core";
-import { Octokit } from "@octokit/rest";
-import { prerelease, rcompare, valid } from "semver";
-import DEFAULT_RELEASE_TYPES from "@semantic-release/commit-analyzer/lib/default-release-types.js";
-import { compareCommits, listTags } from "./github";
+import * as core from '@actions/core';
+import { Octokit } from '@octokit/rest';
+import { prerelease, rcompare, valid } from 'semver';
+import DEFAULT_RELEASE_TYPES from '@semantic-release/commit-analyzer/lib/default-release-types.js';
+import { compareCommits, listTags } from './github';
 
 export async function getValidTags() {
   const tags = await listTags();
@@ -34,15 +34,15 @@ export async function getCommits(sha: string) {
 }
 
 export function getBranchFromRef(ref: string) {
-  return ref.replace("refs/heads/", "");
+  return ref.replace('refs/heads/', '');
 }
 
 export function getLatestTag(tags: Octokit.ReposListTagsResponseItem[]) {
   return (
     tags.find((tag) => !prerelease(tag.name)) || {
-      name: "0.0.0",
+      name: '0.0.0',
       commit: {
-        sha: "HEAD",
+        sha: 'HEAD',
       },
     }
   );
@@ -57,12 +57,10 @@ export function getLatestPrereleaseTag(
     .find((tag) => tag.name.match(identifier));
 }
 
-export function mapCustomReleaseRules(
-  customReleaseTypes: string
-) {
+export function mapCustomReleaseRules(customReleaseTypes: string) {
   return customReleaseTypes
     .split(',')
-    .map(part => {
+    .map((part) => {
       const custom = part.split(':');
       if (custom.length !== 2) {
         core.warning(`${part} is not a valid custom release definition.`);
@@ -71,8 +69,14 @@ export function mapCustomReleaseRules(
       const [keyword, release] = custom;
       return {
         type: keyword,
-        release
+        release,
       };
     })
-    .filter(customRelease => DEFAULT_RELEASE_TYPES.includes(customRelease?.release));
+    .filter((customRelease) => {
+      if (DEFAULT_RELEASE_TYPES.includes(customRelease?.release)) {
+        return true;
+      }
+      core.warning(`${customRelease} is not a valid release type.`);
+      return false;
+    });
 }

src/utils.ts

@@ -15,16 +15,18 @@ export function setInput(key: string, value: string) {
 }
 
 export function setInputs(map: Object) {
-  Object.keys(map).forEach(key => setInput(key, map[key]));
+  Object.keys(map).forEach((key) => setInput(key, map[key]));
 }
 
 export function loadDefaultInputs() {
   const actionYaml = fs.readFileSync(path.join(process.cwd(), 'action.yml'));
   const actionJson = yaml.safeLoad(actionYaml);
-  const defaultInputs = Object
-    .keys(actionJson.inputs)
-    .filter(key => actionJson.inputs[key].default)
-    .reduce((obj, key) => ({ ...obj, [key]: actionJson.inputs[key].default }), {});
+  const defaultInputs = Object.keys(actionJson.inputs)
+    .filter((key) => actionJson.inputs[key].default)
+    .reduce(
+      (obj, key) => ({ ...obj, [key]: actionJson.inputs[key].default }),
+      {}
+    );
   setInputs(defaultInputs);
 }