feat(branch-utilities): added branchName and isPr override via ENV

packages/branch-utilities/src/lib/base.utils.ts

@@ -43,7 +43,12 @@ export function createStageInfo(stage: string): StageInfo {
  */
 export function getBranchInfo(env: unknown, branchName?: string): BranchInfo {
   let isPr = false
-  if (isGithubWorkflow(env)) {
+
+  if (isFullBranchOverrideDefined(env)) {
+    // full branch name override via en vars SC_OVERRIDE_BRANCH_NAME and SC_OVERRIDE_IS_PR
+    branchName = getBranchNameOverride(env)
+    isPr = getIsPrOverride(env)
+  } else if (isGithubWorkflow(env)) {
     // github workflow environment
     branchName = branchName ?? getGithubBranchName(env)
     isPr = isGithubPullRequest(env)
@@ -75,6 +80,20 @@ export function getBranchInfo(env: unknown, branchName?: string): BranchInfo {
   }
 }
 
+export function isFullBranchOverrideDefined(envVars: unknown): envVars is CustomScOverrideEnv {
+  return envVars !== null
+    && typeof (envVars as CustomScOverrideEnv).SC_OVERRIDE_BRANCH_NAME ==='string'
+    && typeof (envVars as CustomScOverrideEnv).SC_OVERRIDE_IS_PR ==='string'
+}
+
+export function getBranchNameOverride(env: CustomScOverrideEnv): string {
+  return env.SC_OVERRIDE_BRANCH_NAME
+}
+
+export function getIsPrOverride(env: CustomScOverrideEnv): boolean {
+  return env.SC_OVERRIDE_IS_PR === 'true'
+}
+
 /**
  * @return Returns the branch name. The name is resolved depending on provided environment (github actions | local).
  */

packages/branch-utilities/src/lib/types/sc-override-env-var.type.ts

@@ -1,5 +1,11 @@
 export interface CustomScOverrideEnv {
-  /** stringified object of type {@link GitHubContext} */
+  /** flag to allow usage of master branch locally */
   // eslint-disable-next-line @typescript-eslint/no-redundant-type-constituents,@typescript-eslint/naming-convention
   SC_OVERRIDE: 'true' | any
+  /** flag to override branchName for getBranchInfo(), needs to be used in conjunction with SC_OVERRIDE_IS_PR */
+  // eslint-disable-next-line @typescript-eslint/no-redundant-type-constituents,@typescript-eslint/naming-convention
+  SC_OVERRIDE_BRANCH_NAME: string | any
+  /** flag to override isPr getBranchInfo(), needs to be used in conjunction with SC_OVERRIDE_IS_PR */
+  // eslint-disable-next-line @typescript-eslint/no-redundant-type-constituents,@typescript-eslint/naming-convention
+  SC_OVERRIDE_IS_PR: string | any
 }