contrib.json

{
  "project": {
    "owner": "videojs",
    "name": "video.js",
    "requirements": [
      {
        "name": "git",
        "info": "http://git-scm.com"
      },
      {
        "name": "node.js",
        "info": "http://nodejs.org"
      }
    ],
    "urls": {
      "git": "https://github.com/videojs/video.js.git",
      "repo_api": "https://api.github.com/repos/videojs/video.js",
      "repo_ui": "https://github.com/videojs/video.js"
    },
    "branches": {
      "development": "master",
      "release": "stable"
    }
  },

  "install": [
    [ "git fetch origin",                             "Get all git branches" ],
    [ "git checkout -b stable origin/stable",         "Create the stable branch for patches" ],
    [ "git remote add upstream {{project.urls.git}}", "Add the upstream project as a remote for pulling changes" ],
    [ "git fetch upstream",                           "Get all upstream branches and changes" ],
    { "include": "update all" }
  ],

  "update": {
    "all": [
      { "include": "update stable" },
      { "include": "update master" },
      [ "npm install", "Download dependencies"],
      [ "grunt", "Build the library" ]
    ],
    "master": [
      [ "git checkout master",      "Switch to the development branch" ],
      [ "git pull upstream master", "Get any changes to master in the main project" ],
      [ "git push origin master",   "Push any changes to your copy of the main project" ]
    ],
    "stable": [
      [ "git checkout stable",      "Switch to the release branch" ],
      [ "git pull upstream stable", "Get any changes to stable in the main project" ],
      [ "git push origin stable",   "Push any changes to your copy of the main project" ]
    ]
  },

  "test": [ "grunt test" ],
  "watch": [ "grunt watch" ],
  "server": [ "grunt connect" ],

  "feature": {
    "desc": "Create a new feature or general enhancement",
    "baseBranch": "master",
    "start": {
      "desc": "Start a new feature",
      "steps": [
        { "include": "update {{project.branches.development}}" },
        { "include": "branch start" }
      ]
    },
    "submit": {
      "desc": "Submit a pull request for a feature when it's finished",
      "steps": [
        { "include": "branch submit" }
      ]
    },
    "delete": {
      "desc": "Delete the current feature branch",
      "steps": [
        { "include": "branch delete" }
      ]
    },
    "accept": {
      "steps": [
        { "include": "update {{project.branches.development}}" },
        { "include": "pull_request accept" }
      ]
    }
  },

  "patch": {
    "desc": "Create an urgent fix for the latest stable version",
    "baseBranch": "stable",
    "new": {
      "alias": "start",
      "desc": "Start a new patch",
      "finished": "Make your changes and then run `contrib patch submit`",
      "steps": [
        { "include": "update {{project.branches.release}}" },
        { "include": "branch start" }
      ]
    },
    "submit": {
      "desc": "Submit a pull request for a patch when it's finished",
      "steps": [
        { "include": "branch submit" }
      ]
    },
    "delete": {
      "desc": "Delete the current patch branch",
      "steps": [
        { "include": "branch delete" }
      ]
    },
    "accept": {
      "steps": [
        { "include": "update {{project.branches.release}}" },
        { "include": "pull_request accept" }
      ]
    }
  },

  "report": {
    "desc": "Submit a bug report",
    "steps": [
      { "prompt": "Title your bug report",                   "id": "title" },
      { "prompt": "What did you do? (steps to reproduce)",   "id": "reproduce" },
      { "prompt": "What did you expect to happen?",          "id": "expected" },
      { "prompt": "What actually happened?",                 "id": "actual" },
      { "prompt": "What version of video.js are you using?", "id": "version" },
      { "prompt": "Are you using any video.js plugins?",     "id": "plugins" },
      { "prompt": "What browsers/platforms did you experience this in (e.g. Win 7, IE10; Android 4, Chrome;)?", "id": "browsers" },
      { "prompt": "Is there a URL to a live example, or a jsbin (e.g. http://jsbin.com/axedog/9999/edit)?",     "id": "example" },
      { "prompt": "Are there any other details you'd like to provide?",                                         "id": "details" },
      { "open": "{{project.urls.repo_ui}}/issues/new?title={{title}}&body=**Steps to reproduce:**\n> {{reproduce}}\n\n**What was expected:**\n> {{expected}}\n\n**What Happened:**\n> {{actual}}\n\n**Video.js Version:**\n> {{version}}\n\n**Plugins:**\n> {{plugins}}\n\n**Browsers experienced on:**\n> {{browsers}}\n\n**Example:**\n> {{example}}\n\n**Other details:**\n> {{details}}" }
    ]
  },

  "request": {
    "desc": "Submit a feature/enhancement request",
    "steps": [
      { "prompt":  "Title your request", "id": "title" },
      { "prompt":  "Describe the feature/enhancement (be as detailed as possible so it's clear who, why, and how it would be used)", "id": "describe" },
      { "prompt":  "Is there any existing documentation or related specifications?", "id": "docs" },
      { "prompt":  "Are there any existing examples?", "id": "examples" },
      { "confirm": "You will be redirected to Github where you can submit this issue, OK?" },
      { "open": "{{project.urls.repo_ui}}/issues/new?title={{ title }}&body=**Describe the feature/enhancement:**\n> {{ describe }}\n\n**Existing docs/specs:**\n> {{ docs }}\n\n**Existing examples:**\n> {{ examples }}" }
    ]
  },

  "release": {
    "desc": "Create and publish a release",
    "steps": [
      [ "git diff --exit-code",             "Ensure there's no unadded changes" ],
      [ "git diff --cached --exit-code",    "Ensure there's no added changes" ],
      { "confirm": "Have the changes been merged into the release branch (stable)?" },
      {
        "id": "type",
        "desc": "Provide the release type",
        "prompt": {
          "message": "release type",
          "default": "patch",
          "type": "text"
        }
      },
      [ "git checkout stable",                     "Checkout the release branch" ],
      [ "git pull upstream stable",                "Update the release branch" ],
      [ "grunt test",                              "Run tests" ],
      [ "grunt chg-release:{{ type }}",            "Update the changelog with the new release" ],
      [ "grunt version:{{ type }}",                "Bump package versions" ],
      [ "grunt",                                   "Build the release" ],
      [ "git add dist/video-js --force",           "Add the (otherwise ignored) release files" ],
      [ "grunt vjsdocs",                           "Rebuild the docs" ],
      [ "grunt cdn-links",                         "Update the cdn urls in the docs" ],
      [ "grunt tagrelease",                        "Tag the release" ],
      [ "git push upstream stable",                "Push changes to the remote" ],
      [ "git push upstream --tags",                "Push tags to the remote" ],
      [ "npm publish",                             "Publish to npm" ],
      [ "git checkout master",                     "Checkout the development branch" ],
      [ "git pull upstream master",                "Update the development branch" ],
      [ "git merge stable",                        "Merge changes" ],
      [ "grunt clean:dist",                        "Remove built dist files to re-ignore them" ],
      [ "git add -u",                              "Add the changes for the removed dist files" ],
      [ "git commit -m 'Removed dist files'",      "Commit the removed dist files" ],
      [ "git push upstream master",                "Push development branch changes" ]
    ]
  },

  "branch": {
    "private": true,
    "start": {
      "steps": [
        { "prompt": "Name the branch",                "id": "name" },
        [ "git checkout -b {{name}} {{baseBranch}}",  "Create the branch" ],
        [ "git push -u origin {{name}}",              "Push the branch to your remote copy of the project" ]
      ]
    },
    "submit": {
      "desc": "Submit a pull request for when the change is finished",
      "steps": [
        { "exec": "git diff --exit-code", "desc": "Test for unadded changes {{ args.[0] }}", "fail": "Make sure all changes have been added and committed, or stashed, before switching branches" },
        { "exec": "git diff --cached --exit-code", "desc": "Test for uncommitted changes", "fail": "Make sure all changes have been added and committed, or stashed, before switching branches" },
        { "include": "test" },
        { "exec": "git rev-parse --abbrev-ref HEAD", "desc": "Get the current branch", "id": "branch" },
        { "confirm": "Are you sure {{branch}} is the branch you want to submit?" },
        { "prompt": "Which github user or org are you submitting from?", "id": "user" },
        { "open": "{{project.urls.repo_ui}}/compare/videojs:{{baseBranch}}...{{user}}:{{branch}}", "desc": "Open the github pull request page" }
      ]
    },
    "delete": {
      "desc": "Delete the current branch",
      "steps": [
        { "exec": "git rev-parse --abbrev-ref HEAD", "desc": "Get the current branch name", "id": "name" },
        { "confirm": "Are you sure '{{name}}' is the branch you want to delete?" },
        { "exec": "git branch -D {{name}}",          "desc": "Delete the local copy of the branch" },
        { "exec": "git push origin :{{name}}",       "desc": "Delete the remote copy of the branch" }
      ]
    }
  },

  "pull_request": {
    "private": true,

    "start": {
      "steps": [
        { "prompt": "What is the the pull request number?", "id": "prNum" },
        { "get": "{{project.urls.repo_api}}/pulls/{{prNum}}", "desc": "Get the PR information", "id": "pr" },
        [ "git checkout -b review-{{pr.user.login}}-{{pr.head.ref}} {{pr.base.ref}}", "Checkout a new branch for reviewing changes" ],
        [ "git pull {{pr.head.repo.ssh_url}} {{pr.head.ref}}",  "Pull in the changes" ],
        [ "grunt test",                                         "Build and run tests" ]
      ]
    },

    "modify": {
      "desc": "Submit a modification to an existing pull request",
      "steps": [
        { "exec": "git diff --exit-code",            "desc": "Test for unadded changes", "fail": "Make sure all changes have been added and committed, or stashed, before switching branches" },
        { "exec": "git diff --cached --exit-code",   "desc": "Test for uncommitted changes", "fail": "Make sure all changes have been added and committed, or stashed, before switching branches" },
        { "include": "test" },
        { "exec": "git rev-parse --abbrev-ref HEAD", "desc": "Get the current branch", "id": "branch" },
        { "confirm": "Are you sure {{branch}} is the branch you want to submit?" },
        { "prompt": "Which github user or org are you submitting from?", "id": "user" },
        { "prompt": "What is the the pull request number?",              "id": "prNum" },
        { "get": "{{project.urls.repo_api}}/pulls/{{prNum}}", "desc": "Get the PR information", "id": "pr" },
        { "exec": "git push -u origin {{branch}}",                                "desc": "Push the changes to the remote repo" },
        { "open": "https://github.com/{{user}}/video.js/compare/{{pr.head.label}}...{{user}}:{{branch}}", "desc": "Open the github pull request page" }
      ]
    },

    "accept": [
      { "prompt": "What is the the pull request number?",              "id": "prNum" },
      { "get": "{{project.urls.repo_api}}/pulls/{{prNum}}",          "desc": "Get the PR information", "id": "pr" },
      { "get": "{{project.urls.repo_api}}/pulls/{{prNum}}/commits",  "desc": "Get the PR commits to access author info", "id": "prCommits" },
      [ "git checkout -b {{pr.user.login}}-{{pr.head.ref}} {{pr.base.ref}}", "Create a new branch for merging the changes" ],
      [ "git fetch {{pr.head.repo.ssh_url}} {{pr.head.ref}}",                "Fetch the changes" ],
      [ "git merge --no-commit --squash FETCH_HEAD",                         "Merge the changes in without committing so they can be squashed" ],
      [ "grunt test",                                                        "Run tests to make sure they still pass" ],
      { "prompt": "Describe this change in one line",                  "id": "line" },
      [ "grunt chg-add:'{{line}} ([view](https\\://github.com/videojs/video.js/pull/{{prNum}}))'", "Add a line to the changelog" ],
      [ "git add CHANGELOG.md",                                              "Add the changlelog change to be committed" ],
      [ "git commit -a --author='{{prCommits.[0].commit.author.name}} <{{prCommits.[0].commit.author.email}}>' -m '{{line}}. closes #{{prNum}}'", "Commit the changes" ],
      { "confirm": "Does everything look ok?" },
      [ "git checkout {{pr.base.ref}}",                                      "Check out the base branch" ],
      [ "git merge {{pr.user.login}}-{{pr.head.ref}}",                       "Merge the changes" ],
      [ "git push origin {{pr.base.ref}}",                                   "Push the changes to your remote copy of the project" ],
      [ "git push upstream {{pr.base.ref}}",                                 "Push the changes to the main project" ],
      [ "git branch -D {{pr.user.login}}-{{pr.head.ref}}",                   "Delete the local branch used for merging" ]
    ]
  }
}