Skip to content

dev-cheat-sheet.md

Latest commit

 

History

History
138 lines (92 loc) · 2.13 KB

dev-cheat-sheet.md

File metadata and controls

138 lines (92 loc) · 2.13 KB

Dev Cheat Sheet

Build CLI (macOS ARM64)

Publish a self-contained single binary:

dotnet publish -c Release -r osx-arm64 \
  --self-contained true \
  -p:PublishSingleFile=true

Install globally:

sudo mv bin/Release/net*/osx-arm64/publish/RackPeek /usr/local/bin/rpk
sudo chmod +x /usr/local/bin/rpk

Verify:

rpk --help

Generate CLI Demo (VHS)

Install tools:

brew install vhs
brew install imagemagick
brew install --cask google-chrome # if not already installed

Run tape:

cd vhs
vhs ./rpk.tape

Capture Web UI Demo

Make script executable:

chmod +x webui_capture.sh

Run:

cd vhs
npm install
node capture.js 
./webui_capture.sh

Requires Chrome + ImageMagick.

Build & Push Multi-Arch Docker Image

Manual release build:

docker buildx build \
  --platform linux/amd64,linux/arm64 \
  -f ./Dockerfile \
  -t aptacode/rackpeek:v0.0.11 \
  -t aptacode/rackpeek:latest \
  --push ..

Notes:

  • Uses buildx for multi-arch
  • Pushes directly to registry
  • Update version tag before running

Run E2E Tests (Playwright)

Install tooling (first time only):

cd Tests.E2e
dotnet tool install --global Microsoft.Playwright.CLI
dotnet build
playwright install

⚠ Re-run playwright install whenever the Microsoft.Playwright NuGet is bumped. Each Playwright release pins a specific Chromium build (e.g. 1.58 ships chromium_headless_shell-1208, 1.59 ships -1217). If the cache is stale every test fails with PlaywrightException : Executable doesn't exist at .../chromium_headless_shell-NNNN. just e2e-setup covers this.

Build Web image (required before running tests):

docker build -t rackpeek:ci -f RackPeek.Web/Dockerfile .

Common Workflows

Rebuild everything quickly

docker build -t rackpeek:ci -f RackPeek.Web/Dockerfile .
cd Tests.E2e && dotnet test

Debugging E2E Tests

Temporarily set in PlaywrightFixture.cs:

Headless = false,
SlowMo = 500,

⚠ Revert to:

Headless = true,

Before committing (CI requires headless mode).