Phabricator-pr-resource

Tracks the diffs created as part of a revision in phabricator.

Deploying to concourse

resource_types:
- name: phabricator-pr
  type: docker-image
  source:
    repository: goddenrich/phabricator-pr-resource
    tag: latest

Source Configuration

• conduit_uri: Required. The uri of the phabricator api.

• conduit_token: Required. The token to use to authenticate the conduit api call.

• repo_uri: Required. The uri of the git repo.

• private_key: Optional. Private key to use when pulling/pushing. Example:

  private_key: |
    -----BEGIN RSA PRIVATE KEY-----
    MIIEowIBAAKCAQEAtCS10/f7W7lkQaSgD/mVeaSOvSF9ql4hf/zfMwfVGgHWjj+W
    <Lots more text>
    DWiJL+OFeg9kawcUL6hQ8JeXPhlImG6RTUffma9+iGQyyBMCGd1l
    -----END RSA PRIVATE KEY-----
  

• username: Optional. Username for HTTP(S) auth when pulling/pushing. This is needed when only HTTP/HTTPS protocol for git is available (which does not support private key auth) and auth is required.

• password: Optional. Password for HTTP(S) auth when pulling/pushing.

• skip_ssl_verification: Optional. Skips git ssl verification by exporting GIT_SSL_NO_VERIFY=true.

• git_config: Optional. If specified as (list of pairs name and value) it will configure git global options, setting each name with each value.

  This can be useful to set options like credential.helper or similar.

  See the git-config(1) manual page for more information and documentation of existing git options.

• https_tunnel: Optional. Information about an HTTPS proxy that will be used to tunnel SSH-based git commands over. Has the following sub-properties:

  • proxy_host: Required. The host name or IP of the proxy server
  • proxy_port: Required. The proxy server's listening port
  • proxy_user: Optional. If the proxy requires authentication, use this username
  • proxy_password: Optional. If the proxy requires authenticat, use this password

Example

Resource configuration for a private repo with an HTTPS proxy:

resource_types:
- name: phabricator-pr
  type: docker-image
  source:
    repository: goddenrich/phabricator-pr-resource
    tag: latest

resources:
- name: pr
  type: phabricator-pr
  source:
    conduit_uri: https://secure.phabricator.com/
    conduit_toke: secret-token-xxxxxx
    repo_uri: git@github.com:concourse/git-resource.git
    private_key: |
      -----BEGIN RSA PRIVATE KEY-----
      MIIEowIBAAKCAQEAtCS10/f7W7lkQaSgD/mVeaSOvSF9ql4hf/zfMwfVGgHWjj+W
      <Lots more text>
      DWiJL+OFeg9kawcUL6hQ8JeXPhlImG6RTUffma9+iGQyyBMCGd1l
      -----END RSA PRIVATE KEY-----
    git_config:
    - name: core.bigFileThreshold
      value: 10m
    https_tunnel:
      proxy_host: proxy-server.mycorp.com
      proxy_port: 3128
      proxy_user: myuser
      proxy_password: myverysecurepassword

Create a branch with the patch of the diff:

- get: pr

Behavior

check: Check for new diffs.

The phabricator api (conduit) is accessed to get any diffs from the given diff on are returned. If no version is given, the most recent diff is returned.

in: Clone the repository, at the given ref.

Clones the default branch of the repository specified by repo_uri to the destination, and creates a new branch with the patch for the diff.

Parameters

• depth: Optional. If a positive integer is given, shallow clone the repository using the --depth option. When attempting to apply the patch the depth is extended till the base of the diff is found.

out: No op (for now)

Currently no-op but plan to return the outcome of the build to phabricator.

Development

Prerequisites

• docker is required - version 17.06.x is tested; earlier versions may also work.

Running the tests (none yet)

Run the tests with the following command:

docker build -t phabricator-pr-resource .

Contributing

Please make all pull requests to the master branch and ensure tests pass locally.