Skip to content

Latest commit

 

History

History
54 lines (37 loc) · 2.41 KB

CONTRIBUTING.md

File metadata and controls

54 lines (37 loc) · 2.41 KB
Raw

Contributing to Local CI

Local Setup

  1. npm i
  2. Open VS Code with this repo at the root of the workspace
  3. VS Code > View > Run > Run Extension:

running the extension

  1. This will open a new VS Code window
  2. In that new window, File > Open > select a repo that has a .circleci/config.yml file
  3. Click the Local CI icon on the left
  4. You should see the CircleCI® jobs for that workspace:

jobs in editor

  1. As you make edits, click Restart in the Local CI repo to see the edits apply in the second window:

restarting the editor

  1. If step 3 causes the warning "The task 'npm: watch' cannot be tracked," you can either activate the extension TypeScript + Webpack Problem Matchers, or manually do npm run watch and click "Debug Anyway."

Linting

npm run lint

This will also run on a pre-commit hook that will install on npm i

Downloading A Build From A Commit

You may want to downlod and install a development .vsix file, instead of installing this extension via the VS Code Marketplace.

You'll need to be logged into at least a free CircleCI account for this.

Also, it'd be good to use Firefox instead of Chrome. It looks like Chrome converts the .vsix file into an unusable .zip file on downloading it.

  1. Click the commit check you want to download the .vsix for. This could be in a PR, or simply the develop branch.
  2. For the package job, click Details
  3. Click the Artifacts tab
  4. Click the .vsix file to download it:
downloading-a-build.mp4

(No audio in this video)

Testing A Build Locally

  1. Enter the Command Palette, either through a shortcut, or View > Command Palette
  2. Type 'Extensions: Install from VSIX'
  3. Select the Local CI .vsix file, maybe the one you downloaded