Introduction to git-branch-is

The git-branch-is utility simplifies branch checking in Git repositories, making it easier for developers to automate workflows and prevent common mistakes. This tool provides a clean API for determining the current branch status, which can help in continuous integration and deployment pipelines.

Key API Examples

Check if on Specific Branch

To check if you’re on a specific branch, use:

 const gitBranchIs = require('git-branch-is');
gitBranchIs('main').then((result) => {
  console.log(result); // true if on 'main' branch
}).catch((err) => {
  console.error(err);
}); 

Multiple Branch Check

Check if the current branch matches any in a list of branches:

 gitBranchIs(['main', 'develop']).then((result) => {
  console.log(result); // true if on 'main' or 'develop' branch
}).catch((err) => {
  console.error(err);
}); 

Negation Check

Check if the branch doesn’t match a specific name:

 gitBranchIs.not('main').then((result) => {
  console.log(result); // true if not on 'main' branch
}).catch((err) => {
  console.error(err);
}); 

Warning on Unsaved Changes

Ensure your script only runs on branches without unsaved changes:

 gitBranchIs.clean().then((result) => {
  console.log(result); // true if there are no unsaved changes
}).catch((err) => {
  console.error(err);
}); 

Combine Multiple Checks

Combine branch and status checks for more complex conditions:

 Promise.all([
  gitBranchIs('main'),
  gitBranchIs.clean()
]).then((results) => {
  if (results.every(Boolean)) {
    console.log('On main branch with clean working directory.');
  }
}).catch((err) => {
  console.error(err);
}); 

Application Example

Let’s create a small application that only allows deployment from the ‘main’ branch when no unsaved changes are present:

 const gitBranchIs = require('git-branch-is');
function canDeploy() {
  return Promise.all([
    gitBranchIs('main'),
    gitBranchIs.clean()
  ]).then((results) => {
    return results.every(Boolean);
  });
}
canDeploy().then((deployable) => {
  if (deployable) {
    console.log('Deploying application...');
    // Add your deployment logic here
  } else {
    console.log('Cannot deploy. Ensure you are on the main branch with no unsaved changes.');
  }
}).catch((err) => {
  console.error('Deployment check failed:', err);
}); 

This script helps ensure that deployments only occur under the correct conditions, reducing the risk of errors and inconsistencies.

Hash: 681c844d8fae5b39cce815772202a1230babc31c1e2a506085da325aef4d78cd