{"action":"created","comment":{"url":"https://api.github.com/repos/googlegenomics/pipelines-tools/pulls/comments/171960928","pull_request_review_id":100911348,"id":171960928,"diff_hunk":"@@ -4,4 +4,61 @@\n This repository contains various tools that are useful when running pipelines\n with the [Google Genomics API][1]. \n \n+# Building the tools\n+\n+In order to build the tools, you will need the [Go][2] tool\n+chain (at least version 1.8).\n+\n+Once Go is installed, you can build the tools by running:\n+\n+```\n+$ go get github.com/googlegenomics/pipelines-tools/...\n+```\n+\n+This will produce binaries in $GOPATH/bin for each tool.\n+\n+# Usage\n+\n+## The `pipelines` tool\n+\n+This tool provides support for running, cancelling and inspecting pipelines.\n+\n+As a simple example, to run a pipeline that prints 'hello world':\n+\n+```\n+$ cat <<EOF > hello.script\n+echo \"hello world\"\n+EOF\n+$ pipelines --project=my-project run --script=hello.script --output=gs://my-bucket/logs --wait\n+```\n+\n+After the pipeline finishes, you can inspect the output using `gsutil`:\n+\n+```\n+$ gsutil cat gs://my-bucket/logs/output\n+```\n+\n+The script file format is described in the [source code for the command][3].\n+\n+## The `migrate-pipeline` tool\n+\n+This tool takes a v1alpha2 run pipeline request and attempts to emit a v2alpha1","path":"README.md","position":42,"original_position":42,"commit_id":"7154aac0164797373930762a0fa37690f3b93d2c","original_commit_id":"7154aac0164797373930762a0fa37690f3b93d2c","user":{"login":"gkelly","id":48158,"avatar_url":"https://avatars1.githubusercontent.com/u/48158?v=4","gravatar_id":"","url":"https://api.github.com/users/gkelly","html_url":"https://github.com/gkelly","followers_url":"https://api.github.com/users/gkelly/followers","following_url":"https://api.github.com/users/gkelly/following{/other_user}","gists_url":"https://api.github.com/users/gkelly/gists{/gist_id}","starred_url":"https://api.github.com/users/gkelly/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/gkelly/subscriptions","organizations_url":"https://api.github.com/users/gkelly/orgs","repos_url":"https://api.github.com/users/gkelly/repos","events_url":"https://api.github.com/users/gkelly/events{/privacy}","received_events_url":"https://api.github.com/users/gkelly/received_events","type":"User","site_admin":false},"body":"I'd mention that it takes a JSON-formatted v1alpha2 pipelines request.","created_at":"2018-03-02T20:59:35Z","updated_at":"2018-03-02T20:59:58Z","html_url":"https://github.com/googlegenomics/pipelines-tools/pull/4#discussion_r171960928","pull_request_url":"https://api.github.com/repos/googlegenomics/pipelines-tools/pulls/4","author_association":"MEMBER","_links":{"self":{"href":"https://api.github.com/repos/googlegenomics/pipelines-tools/pulls/comments/171960928"},"html":{"href":"https://github.com/googlegenomics/pipelines-tools/pull/4#discussion_r171960928"},"pull_request":{"href":"https://api.github.com/repos/googlegenomics/pipelines-tools/pulls/4"}}},"pull_request":{"url":"https://api.github.com/repos/googlegenomics/pipelines-tools/pulls/4","id":172602554,"html_url":"https://github.com/googlegenomics/pipelines-tools/pull/4","diff_url":"https://github.com/googlegenomics/pipelines-tools/pull/4.diff","patch_url":"https://github.com/googlegenomics/pipelines-tools/pull/4.patch","issue_url":"https://api.github.com/repos/googlegenomics/pipelines-tools/issues/4","number":4,"state":"open","locked":false,"title":"Expand the README","user":{"login":"kemp-google","id":28713279,"avatar_url":"https://avatars3.githubusercontent.com/u/28713279?v=4","gravatar_id":"","url":"https://api.github.com/users/kemp-google","html_url":"https://github.com/kemp-google","followers_url":"https://api.github.com/users/kemp-google/followers","following_url":"https://api.github.com/users/kemp-google/following{/other_user}","gists_url":"https://api.github.com/users/kemp-google/gists{/gist_id}","starred_url":"https://api.github.com/users/kemp-google/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/kemp-google/subscriptions","organizations_url":"https://api.github.com/users/kemp-google/orgs","repos_url":"https://api.github.com/users/kemp-google/repos","events_url":"https://api.github.com/users/kemp-google/events{/privacy}","received_events_url":"https://api.github.com/users/kemp-google/received_events","type":"User","site_admin":false},"body":"","created_at":"2018-03-02T20:55:12Z","updated_at":"2018-03-02T20:59:58Z","closed_at":null,"merged_at":null,"merge_commit_sha":"ab10f8eed650e337a4eb160e831370c4d3cc7b26","assignee":null,"assignees":[],"requested_reviewers":[],"requested_teams":[],"labels":[],"milestone":null,"commits_url":"https://api.github.com/repos/googlegenomics/pipelines-tools/pulls/4/commits","review_comments_url":"https://api.github.com/repos/googlegenomics/pipelines-tools/pulls/4/comments","review_comment_url":"https://api.github.com/repos/googlegenomics/pipelines-tools/pulls/comments{/number}","comments_url":"https://api.github.com/repos/googlegenomics/pipelines-tools/issues/4/comments","statuses_url":"https://api.github.com/repos/googlegenomics/pipelines-tools/statuses/7154aac0164797373930762a0fa37690f3b93d2c","head":{"label":"kemp-google:readme","ref":"readme","sha":"7154aac0164797373930762a0fa37690f3b93d2c","user":{"login":"kemp-google","id":28713279,"avatar_url":"https://avatars3.githubusercontent.com/u/28713279?v=4","gravatar_id":"","url":"https://api.github.com/users/kemp-google","html_url":"https://github.com/kemp-google","followers_url":"https://api.github.com/users/kemp-google/followers","following_url":"https://api.github.com/users/kemp-google/following{/other_user}","gists_url":"https://api.github.com/users/kemp-google/gists{/gist_id}","starred_url":"https://api.github.com/users/kemp-google/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/kemp-google/subscriptions","organizations_url":"https://api.github.com/users/kemp-google/orgs","repos_url":"https://api.github.com/users/kemp-google/repos","events_url":"https://api.github.com/users/kemp-google/events{/privacy}","received_events_url":"https://api.github.com/users/kemp-google/received_events","type":"User","site_admin":false},"repo":{"id":123626580,"name":"pipelines-tools","full_name":"kemp-google/pipelines-tools","owner":{"login":"kemp-google","id":28713279,"avatar_url":"https://avatars3.githubusercontent.com/u/28713279?v=4","gravatar_id":"","url":"https://api.github.com/users/kemp-google","html_url":"https://github.com/kemp-google","followers_url":"https://api.github.com/users/kemp-google/followers","following_url":"https://api.github.com/users/kemp-google/following{/other_user}","gists_url":"https://api.github.com/users/kemp-google/gists{/gist_id}","starred_url":"https://api.github.com/users/kemp-google/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/kemp-google/subscriptions","organizations_url":"https://api.github.com/users/kemp-google/orgs","repos_url":"https://api.github.com/users/kemp-google/repos","events_url":"https://api.github.com/users/kemp-google/events{/privacy}","received_events_url":"https://api.github.com/users/kemp-google/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/kemp-google/pipelines-tools","description":"Tools for developing and running pipelines with the Genomics API","fork":true,"url":"https://api.github.com/repos/kemp-google/pipelines-tools","forks_url":"https://api.github.com/repos/kemp-google/pipelines-tools/forks","keys_url":"https://api.github.com/repos/kemp-google/pipelines-tools/keys{/key_id}","collaborators_url":"https://api.github.com/repos/kemp-google/pipelines-tools/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/kemp-google/pipelines-tools/teams","hooks_url":"https://api.github.com/repos/kemp-google/pipelines-tools/hooks","issue_events_url":"https://api.github.com/repos/kemp-google/pipelines-tools/issues/events{/number}","events_url":"https://api.github.com/repos/kemp-google/pipelines-tools/events","assignees_url":"https://api.github.com/repos/kemp-google/pipelines-tools/assignees{/user}","branches_url":"https://api.github.com/repos/kemp-google/pipelines-tools/branches{/branch}","tags_url":"https://api.github.com/repos/kemp-google/pipelines-tools/tags","blobs_url":"https://api.github.com/repos/kemp-google/pipelines-tools/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/kemp-google/pipelines-tools/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/kemp-google/pipelines-tools/git/refs{/sha}","trees_url":"https://api.github.com/repos/kemp-google/pipelines-tools/git/trees{/sha}","statuses_url":"https://api.github.com/repos/kemp-google/pipelines-tools/statuses/{sha}","languages_url":"https://api.github.com/repos/kemp-google/pipelines-tools/languages","stargazers_url":"https://api.github.com/repos/kemp-google/pipelines-tools/stargazers","contributors_url":"https://api.github.com/repos/kemp-google/pipelines-tools/contributors","subscribers_url":"https://api.github.com/repos/kemp-google/pipelines-tools/subscribers","subscription_url":"https://api.github.com/repos/kemp-google/pipelines-tools/subscription","commits_url":"https://api.github.com/repos/kemp-google/pipelines-tools/commits{/sha}","git_commits_url":"https://api.github.com/repos/kemp-google/pipelines-tools/git/commits{/sha}","comments_url":"https://api.github.com/repos/kemp-google/pipelines-tools/comments{/number}","issue_comment_url":"https://api.github.com/repos/kemp-google/pipelines-tools/issues/comments{/number}","contents_url":"https://api.github.com/repos/kemp-google/pipelines-tools/contents/{+path}","compare_url":"https://api.github.com/repos/kemp-google/pipelines-tools/compare/{base}...{head}","merges_url":"https://api.github.com/repos/kemp-google/pipelines-tools/merges","archive_url":"https://api.github.com/repos/kemp-google/pipelines-tools/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/kemp-google/pipelines-tools/downloads","issues_url":"https://api.github.com/repos/kemp-google/pipelines-tools/issues{/number}","pulls_url":"https://api.github.com/repos/kemp-google/pipelines-tools/pulls{/number}","milestones_url":"https://api.github.com/repos/kemp-google/pipelines-tools/milestones{/number}","notifications_url":"https://api.github.com/repos/kemp-google/pipelines-tools/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/kemp-google/pipelines-tools/labels{/name}","releases_url":"https://api.github.com/repos/kemp-google/pipelines-tools/releases{/id}","deployments_url":"https://api.github.com/repos/kemp-google/pipelines-tools/deployments","created_at":"2018-03-02T20:19:39Z","updated_at":"2018-03-02T20:19:41Z","pushed_at":"2018-03-02T20:56:38Z","git_url":"git://github.com/kemp-google/pipelines-tools.git","ssh_url":"git@github.com:kemp-google/pipelines-tools.git","clone_url":"https://github.com/kemp-google/pipelines-tools.git","svn_url":"https://github.com/kemp-google/pipelines-tools","homepage":null,"size":0,"stargazers_count":0,"watchers_count":0,"language":"Go","has_issues":false,"has_projects":true,"has_downloads":true,"has_wiki":false,"has_pages":false,"forks_count":0,"mirror_url":null,"archived":false,"open_issues_count":0,"license":{"key":"apache-2.0","name":"Apache License 2.0","spdx_id":"Apache-2.0","url":"https://api.github.com/licenses/apache-2.0"},"forks":0,"open_issues":0,"watchers":0,"default_branch":"master"}},"base":{"label":"googlegenomics:master","ref":"master","sha":"940033a7e13ee6ed2f7df2346da1b6458953ceb5","user":{"login":"googlegenomics","id":7434120,"avatar_url":"https://avatars2.githubusercontent.com/u/7434120?v=4","gravatar_id":"","url":"https://api.github.com/users/googlegenomics","html_url":"https://github.com/googlegenomics","followers_url":"https://api.github.com/users/googlegenomics/followers","following_url":"https://api.github.com/users/googlegenomics/following{/other_user}","gists_url":"https://api.github.com/users/googlegenomics/gists{/gist_id}","starred_url":"https://api.github.com/users/googlegenomics/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/googlegenomics/subscriptions","organizations_url":"https://api.github.com/users/googlegenomics/orgs","repos_url":"https://api.github.com/users/googlegenomics/repos","events_url":"https://api.github.com/users/googlegenomics/events{/privacy}","received_events_url":"https://api.github.com/users/googlegenomics/received_events","type":"Organization","site_admin":false},"repo":{"id":123620762,"name":"pipelines-tools","full_name":"googlegenomics/pipelines-tools","owner":{"login":"googlegenomics","id":7434120,"avatar_url":"https://avatars2.githubusercontent.com/u/7434120?v=4","gravatar_id":"","url":"https://api.github.com/users/googlegenomics","html_url":"https://github.com/googlegenomics","followers_url":"https://api.github.com/users/googlegenomics/followers","following_url":"https://api.github.com/users/googlegenomics/following{/other_user}","gists_url":"https://api.github.com/users/googlegenomics/gists{/gist_id}","starred_url":"https://api.github.com/users/googlegenomics/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/googlegenomics/subscriptions","organizations_url":"https://api.github.com/users/googlegenomics/orgs","repos_url":"https://api.github.com/users/googlegenomics/repos","events_url":"https://api.github.com/users/googlegenomics/events{/privacy}","received_events_url":"https://api.github.com/users/googlegenomics/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/googlegenomics/pipelines-tools","description":"Tools for developing and running pipelines with the Genomics API","fork":false,"url":"https://api.github.com/repos/googlegenomics/pipelines-tools","forks_url":"https://api.github.com/repos/googlegenomics/pipelines-tools/forks","keys_url":"https://api.github.com/repos/googlegenomics/pipelines-tools/keys{/key_id}","collaborators_url":"https://api.github.com/repos/googlegenomics/pipelines-tools/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/googlegenomics/pipelines-tools/teams","hooks_url":"https://api.github.com/repos/googlegenomics/pipelines-tools/hooks","issue_events_url":"https://api.github.com/repos/googlegenomics/pipelines-tools/issues/events{/number}","events_url":"https://api.github.com/repos/googlegenomics/pipelines-tools/events","assignees_url":"https://api.github.com/repos/googlegenomics/pipelines-tools/assignees{/user}","branches_url":"https://api.github.com/repos/googlegenomics/pipelines-tools/branches{/branch}","tags_url":"https://api.github.com/repos/googlegenomics/pipelines-tools/tags","blobs_url":"https://api.github.com/repos/googlegenomics/pipelines-tools/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/googlegenomics/pipelines-tools/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/googlegenomics/pipelines-tools/git/refs{/sha}","trees_url":"https://api.github.com/repos/googlegenomics/pipelines-tools/git/trees{/sha}","statuses_url":"https://api.github.com/repos/googlegenomics/pipelines-tools/statuses/{sha}","languages_url":"https://api.github.com/repos/googlegenomics/pipelines-tools/languages","stargazers_url":"https://api.github.com/repos/googlegenomics/pipelines-tools/stargazers","contributors_url":"https://api.github.com/repos/googlegenomics/pipelines-tools/contributors","subscribers_url":"https://api.github.com/repos/googlegenomics/pipelines-tools/subscribers","subscription_url":"https://api.github.com/repos/googlegenomics/pipelines-tools/subscription","commits_url":"https://api.github.com/repos/googlegenomics/pipelines-tools/commits{/sha}","git_commits_url":"https://api.github.com/repos/googlegenomics/pipelines-tools/git/commits{/sha}","comments_url":"https://api.github.com/repos/googlegenomics/pipelines-tools/comments{/number}","issue_comment_url":"https://api.github.com/repos/googlegenomics/pipelines-tools/issues/comments{/number}","contents_url":"https://api.github.com/repos/googlegenomics/pipelines-tools/contents/{+path}","compare_url":"https://api.github.com/repos/googlegenomics/pipelines-tools/compare/{base}...{head}","merges_url":"https://api.github.com/repos/googlegenomics/pipelines-tools/merges","archive_url":"https://api.github.com/repos/googlegenomics/pipelines-tools/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/googlegenomics/pipelines-tools/downloads","issues_url":"https://api.github.com/repos/googlegenomics/pipelines-tools/issues{/number}","pulls_url":"https://api.github.com/repos/googlegenomics/pipelines-tools/pulls{/number}","milestones_url":"https://api.github.com/repos/googlegenomics/pipelines-tools/milestones{/number}","notifications_url":"https://api.github.com/repos/googlegenomics/pipelines-tools/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/googlegenomics/pipelines-tools/labels{/name}","releases_url":"https://api.github.com/repos/googlegenomics/pipelines-tools/releases{/id}","deployments_url":"https://api.github.com/repos/googlegenomics/pipelines-tools/deployments","created_at":"2018-03-02T19:20:13Z","updated_at":"2018-03-02T20:16:58Z","pushed_at":"2018-03-02T20:56:39Z","git_url":"git://github.com/googlegenomics/pipelines-tools.git","ssh_url":"git@github.com:googlegenomics/pipelines-tools.git","clone_url":"https://github.com/googlegenomics/pipelines-tools.git","svn_url":"https://github.com/googlegenomics/pipelines-tools","homepage":null,"size":0,"stargazers_count":1,"watchers_count":1,"language":"Go","has_issues":true,"has_projects":true,"has_downloads":true,"has_wiki":false,"has_pages":false,"forks_count":2,"mirror_url":null,"archived":false,"open_issues_count":1,"license":{"key":"apache-2.0","name":"Apache License 2.0","spdx_id":"Apache-2.0","url":"https://api.github.com/licenses/apache-2.0"},"forks":2,"open_issues":1,"watchers":1,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/googlegenomics/pipelines-tools/pulls/4"},"html":{"href":"https://github.com/googlegenomics/pipelines-tools/pull/4"},"issue":{"href":"https://api.github.com/repos/googlegenomics/pipelines-tools/issues/4"},"comments":{"href":"https://api.github.com/repos/googlegenomics/pipelines-tools/issues/4/comments"},"review_comments":{"href":"https://api.github.com/repos/googlegenomics/pipelines-tools/pulls/4/comments"},"review_comment":{"href":"https://api.github.com/repos/googlegenomics/pipelines-tools/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/googlegenomics/pipelines-tools/pulls/4/commits"},"statuses":{"href":"https://api.github.com/repos/googlegenomics/pipelines-tools/statuses/7154aac0164797373930762a0fa37690f3b93d2c"}},"author_association":"CONTRIBUTOR"}}
{"actor":{"display_login":"gkelly"}}