config.example.js

var port = process.env.PORT || 3000;

// Support text emojis and all unicode emojis / symbols (as of Dec 2018)
// See: https://www.regextester.com/106421
var emoji =
  "(\u00a9|\u00ae|[\u2000-\u3300]|\ud83c[\ud000-\udfff]|\ud83d[\ud000-\udfff]|\ud83e[\ud000-\udfff])";
var emojiText = ":[^\n:]+:";
var signature = "(" + emojiText + "|" + emoji + ")";

module.exports = {
  // This is the title of the window & navbar heading
  title: "Pulldasher",

  // This is the port Pulldasher will run on. If you want to have multiple
  // instances of Pulldasher running on the same server, just assign them
  // different ports.
  port: port,

  // The use of the Github API in Pulldasher is slightly unconventional.
  // Rather than using a token for the currently-logged-in user to access the
  // API, we use one token belonging to the organization for everyone. This is
  // driven by Pulldasher's back-end/front-end separation. Because the backend
  // has to be able to access the API even when no one is logged into the front
  // end, it can't use the users' tokens. The user logins are used only for
  // determining permissions and the active user.
  //
  // To use Pulldasher, you'll need to set up the following on GitHub:
  // 1. A GitHub OAuth Application for your organization (see Settings > OAuth
  // applications on GitHub)
  //   - The homepage URL will be the URL at which Pulldasher is available on
  //     your machine
  //   - The authorization callback URL will be the URL below under
  //     callbackURL.
  // 2. An API token that has access to the repo you're going to track (see
  // Settings > Personal access tokens on GitHub)
  // 3. A GitHub webhook on the repo you want to monitor (Settings (on the
  //    repo) > Webhooks > Add webhook)
  //   - The Payload URL should be the externally-visible URL of the Pulldasher
  //     instance with '/hooks/main' appended and a GET param named `secret`
  //     containing the secret from `hook_secret` below.
  //   - Content type should be `application/x-www-form-urlencoded`
  //   - Choose to be sent individual events, and then check the Issue comments,
  //     Issues, Pull requests, Pull request review comments, Pushes, and
  //     Statuses boxes
  github: {
    // Get this from the GitHub application setup page.
    clientId: "your github application client id",
    secret: "your github appliction secret",
    // Where GitHub will send the user's browser after authentication.
    callbackURL: "http://localhost:" + port + "/auth/github/callback",
    // An API token for the backend to make API requests with.
    token: "oauth api token for server-side api calls",
    // This will need to be the same secret you use on the Webhooks page for
    // the repo Pulldasher is going to monitor.
    hook_secret:
      "some random string to use (?secret=oxwm5gks) to 'secure' github hook handlers",
    // Limit access to specific users or teams.
    requireOrg: "Limit access to users belonging to this github organization",
    requireTeam:
      "[Optional] Limit access to users belonging to this team name within the above github organization, uses the slug version of the team name, i.e. 'some-team' from @SomeOrg/some-team",
  },
  session: {
    secret: "secret for signing session cookies",
  },

  // List of repositories for pulldasher to watch.
  repos: [
    // Just listing the repo as a string indicates pulldasher should consider
    // CI passing if all the statuses that exist are passing and that there
    // is at least one.
    "owner/repo",
    // Listing them like this allows being more explicit with the commit
    // statuses
    {
      name: "owner/otherRepo",
      requiredStatuses: ["tests", "build", "codeClimate"],
      ignoredStatuses: ["coverage"],
    },
  ],

  // The usual MySQL stuff. Like every other MySQL webapp, basically.
  // You will need to source the `schema.sql` file in the database to create
  // all the tables that Pulldasher expects.
  mysql: {
    host: "mysql remote host URL",
    db: "database name",
    user: "username",
    pass: "password",
  },
  // The tags Pulldasher uses to determine how many CR and QA are required for
  // a given pull. The names are currently non-negotiable as far as the
  // frontend is concerned, but the regex may be changed to your heart's
  // content.
  body_tags: [
    {
      name: "cr_req",
      regex: /\bcr_req ([0-9]+)\b/i,
      default: 2,
    },
    {
      name: "qa_req",
      regex: /\bqa_req ([0-9]+)\b/i,
      default: 1,
    },
    {
      name: "closes",
      regex: /\b(?:close(?:s|d)?|fix(?:es|ed)?|resolve(?:s|d)?) #([0-9]+)\b/i,
      default: null,
    },
    {
      name: "connects",
      regex: /\b(?:connect(?:s|ed)? to|connects) #([0-9]+)\b/i,
      default: null,
    },
  ],
  // Tags which indicate a comment is significant and should be parsed.
  // The regex may be customized to change the tag used in GitHub.
  tags: [
    {
      name: "dev_block",
      // This regex supports thins like :smile: as well as the actual
      // unicode representation of emoticons. Mainly added because github
      // started making their autocompletor inject actual unicode emojis
      // in the text.
      regex: new RegExp("\\bdev_block " + signature, "i"),
    },
    {
      name: "un_dev_block",
      regex: new RegExp("\\bun_dev_block " + signature, "i"),
    },
    {
      name: "deploy_block",
      regex: new RegExp("\\bdeploy_block " + signature, "i"),
    },
    {
      name: "un_deploy_block",
      regex: new RegExp("\\bun_deploy_block " + signature, "i"),
    },
    {
      name: "QA",
      regex: new RegExp("\\bQA " + signature, "i"),
    },
    {
      name: "CR",
      regex: new RegExp("\\bCR " + signature, "i"),
    },
  ],

  /**
   * This is a list of objects describing labels on issues which should be
   * converted to properties on the issue. Note that if more than one label
   * matches the regex, only one will appear in the property.
   */
  labels: [
    {
      name: "difficulty",
      regex: /^size: [0-9]+$/,
      // Take in a string (or null, when a label is deleted), returns the
      // new value to be stored: issue[name] = process(label)
      process: function (label) {
        var match = label ? label.match(/[0-9]+/) : null;
        return match ? parseInt(match[0], 10) : null;
      },
    },
  ],

  // Where to store the PID of the pulldasher process when run.
  pidFile: "/var/run/pulldasher.pid",
  // Setting this to true prints more debugging information.
  debug: true,
  // The time in ms before an unauthenticated websocket connection times out.
  unauthenticated_timeout: 10 * 1000,
  // The time in ms before an authentication token times out.
  token_timeout: 100 * 1000,
};