@cjpaisley/bitbucket-feed v0.0.11

bitbucket-feed

This is a Faros feed that produces data for the VCS schema.

The feed:

• Pulls the following resources from Bitbucket REST API for each workspace the authenticated user has access to:
  • Workspace users
  • Repositories
    • Pull Requests
    • Issues
    • Commits

Quickstart

:clipboard: NOTE: Running this feed requires a valid Faros account. To setup Faros see the getting started guide

Installation

npm install -g @faros-ai/bitbucket-feed

Authentication

Running the feed requires a valid Bitbucket account and a Bitbucket user/client. Currently the minimum required scopes for this feed are

• issue - Read your repositories' issues
• repository - Read your repositories
• pullrequest - Read your repositories and their pull requests

Using username and password

--username {bitbucket username} --password {bitbucket password}

or short flags

-u{bitbucket username} -p{your bitbucket password}

Using token

--token {bitbucket token}

or short flag

-t{bitbucket token}

Bitbucket server

The feed defaults to pulling data from the Bitbucket Cloud REST API v2 (https://api.bitbucket.org/2.0). To run against a different Bitbucket server:

--base-url {bitbucket base url}

or short flag

-b{bitbucket base url}

Faros feeds server

By default the feed will push records to the Faros Cloud production server. You can point to a different Faros server with:

--server-url {faros server url}

or short flag

-s{faros server url}

Run the feed

$ bitbucket-feed -t'token' -k'faros api key'

or

$ bitbucket-feed -u'username' -p'password' -k'faros api key'

With the optional configs

$ bitbucket-feed -t'token' -k'faros api key' -b'https://acme-bitbucket.org' -s'https://acme-faros.org'

This will call the feeds server and create a new revision with the collected data. The revision ID as well as a few statistics are logged as part of the output.