feat: add rule for branch name (#20)

* feat: add rule for branch name

* refactor: naming

.github/workflows/ci.yml

@@ -69,4 +69,5 @@ jobs:
           assigneeRequired: true
           checklistRequired: true
           semanticTitleRequired: true
+          semanticBranchNameRequired: true
           repoToken: ${{ secrets.SECRET_TOKEN }}

README.md

@@ -62,5 +62,6 @@ jobs:
           assigneeRequired: true # If true, the PR must have at least one assignee
           checklistRequired: true # If true, the PR must have a checklist on the PR body
           semanticTitleRequired: true # If true, the PR must have a semantic title. The title must follow the conventional commits specification
+          semanticBranchNameRequired: true # If true, the PR must have a semantic branch name
           repoToken: ${{ secrets.SECRET_TOKEN }} # Personal Access Token with repo scope
 ```

action.yml

@@ -19,6 +19,10 @@ inputs:
     description: 'Whether a semantic title is required or not'
     required: true
     default: 'true'
+  semanticBranchNameRequired:
+    description: 'Whether a semantic branch name is required or not'
+    required: true
+    default: 'true'
   repoToken:
     description: 'The repository token'
     required: true

src/constants/index.ts

@@ -2,5 +2,6 @@ import CHECKLIST_KEYS from './checklistKeys';
 import COMMIT_KEYS from './commitKeys';
 import INPUT_KEYS from './inputKeys';
 import QUESTIONS from './questions';
+import PULL_REQUEST from './pullRequest';
 
-export { CHECKLIST_KEYS, COMMIT_KEYS, INPUT_KEYS, QUESTIONS };
+export { CHECKLIST_KEYS, COMMIT_KEYS, INPUT_KEYS, QUESTIONS, PULL_REQUEST };

src/constants/inputKeys.ts

@@ -3,6 +3,7 @@ const INPUT_KEYS = Object.freeze({
   ASSIGNEE_REQUIRED: 'assigneeRequired',
   CHECKLIST_REQUIRED: 'checklistRequired',
   SEMANTIC_TITLE_REQUIRED: 'semanticTitleRequired',
+  SEMANTIC_BRANCH_NAME_REQUIRED: 'semanticBranchNameRequired',
   REPO_TOKEN: 'repoToken'
 });
 

src/constants/pullRequest.ts

@@ -0,0 +1,17 @@
+const PULL_REQUEST = Object.freeze({
+  PREFIXES: Object.freeze([
+    'build',
+    'chore',
+    'ci',
+    'docs',
+    'feature',
+    'fix',
+    'perf',
+    'refactor',
+    'revert',
+    'style',
+    'test'
+  ])
+});
+
+export default PULL_REQUEST;

src/hooks/useInputs.ts

@@ -7,6 +7,7 @@ type UseInputsReturnTypes = {
   isAssigneeRequired: boolean;
   isChecklistRequired: boolean;
   isSemanticTitleRequired: boolean;
+  isSemanticBranchNameRequired: boolean;
   repoToken: string;
 };
 
@@ -27,13 +28,18 @@ export default function useInputs(): UseInputsReturnTypes {
     core.getInput(INPUT_KEYS.SEMANTIC_TITLE_REQUIRED, { required: true })
   );
 
+  const isSemanticBranchNameRequired = Boolean(
+    core.getInput(INPUT_KEYS.SEMANTIC_BRANCH_NAME_REQUIRED, { required: true })
+  );
+
   const repoToken = core.getInput(INPUT_KEYS.REPO_TOKEN, { required: true });
 
   return {
     isReviewerRequired,
     isAssigneeRequired,
     isChecklistRequired,
     isSemanticTitleRequired,
+    isSemanticBranchNameRequired,
     repoToken
   };
 }

src/lib/bot.ts

@@ -36,6 +36,11 @@ async function commentErrors(errors: string[]) {
     return;
   }
 
+  if (await pullRequest.missingSemanticBranchName()) {
+    await commentAndClosePR();
+    return;
+  }
+
   await removeOldPRComments();
 
   const octokit = useOctokit();
@@ -76,4 +81,21 @@ async function commentDraftPR() {
   });
 }
 
+async function commentAndClosePR() {
+  const octokit = useOctokit();
+  const { PROwner } = await pullRequest.getPRInfo();
+
+  await octokit.rest.issues.createComment({
+    ...github.context.repo,
+    issue_number: github.context.issue.number,
+    body: `BOT MESSAGE :robot:\n\n\nPlease follow the semantic branch naming convention :construction:\n\n\n@${PROwner}`
+  });
+
+  await octokit.rest.pulls.update({
+    ...github.context.repo,
+    pull_number: github.context.issue.number,
+    state: 'closed'
+  });
+}
+
 export default { commentErrors };

src/lib/pullRequest.ts

@@ -2,7 +2,7 @@ import * as github from '@actions/github';
 import * as core from '@actions/core';
 
 import { useOctokit, useInputs } from '@app/hooks';
-import { COMMIT_KEYS } from '@app/constants';
+import { COMMIT_KEYS, PULL_REQUEST } from '@app/constants';
 
 async function getPRInfo() {
   const octokit = useOctokit();
@@ -24,6 +24,7 @@ async function getPRInfo() {
     isAssigned: !!issue?.data?.assignee,
     hasReviewers: !!PR?.data?.requested_reviewers?.length,
     PROwner: PR?.data?.user?.login ?? '',
+    branchName: PR?.data?.head?.ref ?? '',
     isMerged: PR?.data?.merged_at !== null
   };
 }
@@ -83,11 +84,37 @@ async function missingReviewers() {
   return !hasReviewers;
 }
 
+async function missingSemanticBranchName() {
+  const { isSemanticBranchNameRequired } = useInputs();
+  const { branchName } = await getPRInfo();
+
+  if (!isSemanticBranchNameRequired) {
+    return false;
+  }
+
+  return isInvalidBranchName(branchName);
+}
+
+function isInvalidBranchName(title: string) {
+  if (!PULL_REQUEST.PREFIXES.some(prefix => title.startsWith(prefix))) {
+    return true;
+  }
+
+  const titleRegex = /^[a-z]+(?:\/[a-z-]+)+$/;
+
+  if (!titleRegex.test(title)) {
+    return true;
+  }
+
+  return false;
+}
+
 export default {
   getPRInfo,
   hasSemanticTitle,
   hasTaskNumber,
   missingAssignees,
   missingSemanticTitle,
-  missingReviewers
+  missingReviewers,
+  missingSemanticBranchName
 };