aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/packages/turbo-ignore/src/checkCommit.ts
blob: af6108eaa050cad131833e6efd52bd44b781dd26 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
import { execSync } from "child_process";

export const skipAllCommits = [
  `[skip ci]`,
  `[ci skip]`,
  `[no ci]`,
  `[skip vercel]`,
  `[vercel skip]`,
];

export const forceAllCommits = [`[vercel deploy]`, `[vercel build]`];

export function skipWorkspaceCommits({ workspace }: { workspace: string }) {
  return [`[vercel skip ${workspace}]`];
}

export function forceWorkspaceCommits({ workspace }: { workspace: string }) {
  return [`[vercel deploy ${workspace}]`, `[vercel build ${workspace}]`];
}

export function getCommitDetails() {
  // if we're on Vercel, use the provided commit message
  if (process.env.VERCEL === "1") {
    if (process.env.VERCEL_GIT_COMMIT_MESSAGE) {
      return process.env.VERCEL_GIT_COMMIT_MESSAGE;
    }
  }
  return execSync("git show -s --format=%B").toString();
}

export function checkCommit({ workspace }: { workspace: string }): {
  result: "skip" | "deploy" | "continue" | "conflict";
  scope: "global" | "workspace";
  reason: string;
} {
  const commitMessage = getCommitDetails();
  const findInCommit = (commit: string) => commitMessage.includes(commit);

  // check workspace specific messages first
  const forceWorkspaceDeploy = forceWorkspaceCommits({ workspace }).find(
    findInCommit
  );
  const forceWorkspaceSkip = skipWorkspaceCommits({ workspace }).find(
    findInCommit
  );

  if (forceWorkspaceDeploy && forceWorkspaceSkip) {
    return {
      result: "conflict",
      scope: "workspace",
      reason: `Conflicting commit messages found: ${forceWorkspaceDeploy} and ${forceWorkspaceSkip}`,
    };
  }

  if (forceWorkspaceDeploy) {
    return {
      result: "deploy",
      scope: "workspace",
      reason: `Found commit message: ${forceWorkspaceDeploy}`,
    };
  }

  if (forceWorkspaceSkip) {
    return {
      result: "skip",
      scope: "workspace",
      reason: `Found commit message: ${forceWorkspaceSkip}`,
    };
  }

  // check global messages last
  const forceDeploy = forceAllCommits.find(findInCommit);
  const forceSkip = skipAllCommits.find(findInCommit);

  if (forceDeploy && forceSkip) {
    return {
      result: "conflict",
      scope: "global",
      reason: `Conflicting commit messages found: ${forceDeploy} and ${forceSkip}`,
    };
  }

  if (forceDeploy) {
    return {
      result: "deploy",
      scope: "global",
      reason: `Found commit message: ${forceDeploy}`,
    };
  }

  if (forceSkip) {
    return {
      result: "skip",
      scope: "global",
      reason: `Found commit message: ${forceSkip}`,
    };
  }

  return {
    result: "continue",
    scope: "global",
    reason: `No deploy or skip string found in commit message.`,
  };
}