Skip to content

Instantly share code, notes, and snippets.

🚀 GitHub Actions & Release Workflow

This document explains how to use the automated GitHub Actions workflows for building and releasing GhSwitch.

📋 Available Workflows

1. 🔨 Build Workflow (.github/workflows/build.yml)

Triggers:

  • Push to main or develop branches

Repository Guidelines

Project Structure & Module Organization

  • Source: src/ (CLI entry flow in src/cli.ts, operations in src/flows.ts, Git/SSH helpers in src/git.ts and src/ssh.ts, shared utilities in src/utils/).
  • Entry points: index.ts (invokes main() from src/cli.ts).
  • Build artifacts: build/ (native binaries produced by Bun compile).
  • Scripts: release/build/install helpers in build.sh, release.sh, install.sh, publish-npm.sh, test-installation.sh.
  • Config: package.json, tsconfig.json.

Build, Test, and Development Commands