Skip to content

Getting Started

Get BaseCoat assets into your repo in under 5 minutes.

Prerequisites

  • GitHub repo with Copilot enabled
  • gh CLI or direct repo access

Run the sync script in your repo root:

$sourceRepo = "YOUR-ORG/basecoat"
$tag = (gh release list --repo $sourceRepo --limit 1 --json tagName -q '.[0].tagName')
$version = $tag.TrimStart('v')
$url = "https://github.com/$sourceRepo/releases/download/$tag/base-coat-$version.zip"
Invoke-WebRequest $url -OutFile base-coat.zip
Expand-Archive base-coat.zip -DestinationPath .github/base-coat -Force
Remove-Item base-coat.zip

curl -fsSL https://raw.githubusercontent.com/YOUR-ORG/basecoat/main/sync.sh | bash

After syncing, your repo will have a .github/base-coat/ directory containing all BaseCoat assets.

Option 2: Manual setup

  1. Go to the latest release page for your source repository
  2. Download base-coat-<version>.zip
  3. Extract to .github/base-coat/ in your repo
  4. Commit the result

Verify your sync

Check the version installed:

cat .github/base-coat/version.json

Keep it up to date

Add the version drift detector to your repo — it opens an issue automatically when BaseCoat has a new release:

# .github/workflows/check-basecoat-version.yml
name: Check BaseCoat Version
on:
  schedule:
    - cron: '0 9 * * 1'  # Weekly Monday 09:00 UTC
  workflow_dispatch:
permissions:
  actions: read
  contents: read
  issues: write
  pull-requests: write
jobs:
  update:
    uses: ivegamsft/basecoat/.github/workflows/check-basecoat-version-callable.yml@9ab8894828e3a887d97c3383e7f23ed892d9a088
    with:
      stage_path: .github/base-coat
      source_repo: ivegamsft/basecoat
      fetch_host: github.com
      update_actor: ${{ vars.BASECOAT_UPDATE_ACTOR }}
    secrets:
      update_token: ${{ secrets.BASECOAT_UPDATE_TOKEN }}
      fetch_token: ${{ secrets.BASECOAT_FETCH_TOKEN }}

Next steps