CircleCI artifacts redirector

Path resolver and redirect server of CircleCI's build artifacts.

Getting started

Run by docker

With this command, the redirect server will be listening on port 8080:

$ docker run -d -p 8080:80 yhatt/circleci-artifacts-redirector

Run express server

$ git clone https://github.com/yhatt/circleci-artifacts-redirector.git

$ npm install
$ npm start

How to use

You can access to the CircleCI build artifact URL with redirect. It would resolve from the path specified by query options.

http://localhost:8080/?path=artifact.html&user=yhatt&project=circleci-artifacts-redirector&token=xxxxxxxxxxxxxxxx

Options

Reqruied

• user: User name of repository.
• project: Project name of repository.
• token: CircleCI's API token for build artifacts. You could create it in User Settings > Personal API Tokens on CircleCI.
• path: The path to build artifact.

Optional

• vcs: VCS type to pass to API. (github by default)
• branch: The name of branch that you want to get artifacts. (master by default)
• build: Build number of CircleCI. (latest by default)
• filter: Restricts which builds are returned. See CircleCI API reference.

Configuration

Environments

• CIRCLECI_ARTIFACTS_REDIRECTOR_PORT: Listening port of express server (8080 by default with running locally)

direnv support

You can configure specific envs if you are using direnv and allowed it.

$ direnv allow
$ cp ./.envrc.local{.example,}
$ vi ./.envrc.local

Author

Yuki Hattori (@yhatt)

License

This plugin releases under the MIT License.