deploy-to-github-pages/lib/options/options.js

A Node library that makes deploying a directory on a branch to GitHub pages easy and automatic.

module.exports = { createOptions };

function createOptions(passedOptions) {
  const options = extendPassedOptions(passedOptions);

  validateOptions(options);

  return options;
}

function extendPassedOptions(options) {
  return extendWithDefaultOptions(
    extendWithGithubTokenVariable(
      extendWithCircleVariablesIfCircle(extendWithGithubActionsVariablesIfGithubActions(options)),
    ),
  );
}

function extendWithDefaultOptions(options) {
  return {
    directory: 'public',
    branch: 'master',
    defaultBranch: 'master',
    dotfiles: false,
    verbose: false,
    ...options,
  };
}

function extendWithGithubTokenVariable(options) {
  return process.env.GITHUB_TOKEN ? { token: process.env.GITHUB_TOKEN, ...options } : options;
}

function extendWithGithubActionsVariablesIfGithubActions(options) {
  if (!process.env.GITHUB_WORKFLOW) {
    return options;
  }

  const [owner, ...repoParts] = process.env.GITHUB_REPOSITORY.split('/');
  const repo = repoParts.join('/');
  const branch = process.env.GITHUB_REF.replace('refs/heads/', '');
  const buildUrl = `https://github.com/${process.env.GITHUB_REPOSITORY}/actions/runs/${process.env.GITHUB_RUN_ID}`;

  return {
    owner,
    repo,
    branch,
    buildUrl,
    ...options,
  };
}

function extendWithCircleVariablesIfCircle(options) {
  return process.env.CIRCLECI
    ? {
        owner: process.env.CIRCLE_PROJECT_USERNAME,
        repo: process.env.CIRCLE_PROJECT_REPONAME,
        branch: process.env.CIRCLE_BRANCH,
        buildUrl: process.env.CIRCLE_BUILD_URL,
        ...options,
      }
    : options;
}

function validateOptions(options) {
  const requiredOptions = ['token', 'owner', 'repo', 'branch'];

  const missingOptions = requiredOptions.filter(name => !options[name]);

  if (missingOptions.length > 0) {
    throw new Error(`Missing options: ${missingOptions.join(', ')}`);
  }
}