Skip to content

development-workflow.md

Latest commit

 

History

History
92 lines (69 loc) · 2.78 KB

development-workflow.md

File metadata and controls

92 lines (69 loc) · 2.78 KB
Raw

Development Workflow

MicroC2 uses a two-branch integration model:

  • main is the stable branch. It should represent code that is ready for regular use in controlled lab environments.
  • dev is the development integration branch. Issue branches start from dev and merge back into dev.
  • Issue branches should be short-lived and named after their work, for example issue/86-listener-lifecycle or feature/payload-build-profiles.

Normal Issue Flow

git fetch origin
git switch dev
git pull --ff-only
git switch -c issue/<number>-short-description

Open the pull request back into dev. The context-aware CI workflow runs only the relevant suites for the files changed by the branch.

Stable Promotion Flow

When dev reaches a coherent milestone, open a pull request from dev into main. Promotion pull requests run the full server, agent, static, formatting advisory, and release package checks.

After the promotion merges, create or update any release notes from the merged changes. Direct feature work should not target main.

Required Checks

The protected dev branch should require:

  • CI Gate
  • foxguard

The protected main branch should require:

  • CI Gate
  • Release Package
  • foxguard

CI Gate is the stable required GitHub Actions status. It depends on the path-selected suites and fails if any selected blocking suite fails. This keeps branch protection stable even when a path-specific job is intentionally skipped. It also enforces that pull requests into main come from dev.

Context-Aware Suites

  • Server changes run Go Server: go test ./..., go vet ./..., and a server build in server/.
  • Agent changes run Rust Agent: cargo test --locked, cargo clippy --locked --all-targets, and cargo build --locked in agent/.
  • Static UI or script changes run Static Assets And Scripts: shell syntax checks and JavaScript syntax checks.
  • Pull requests into main run every suite regardless of path, because they are release-promotion candidates.
  • Documentation-only changes to dev can pass through CI Gate without running server or agent builds.

Format Advisory is intentionally non-blocking until the existing formatting backlog is cleaned up. Once formatting has been normalized, it can become a blocking suite.

Foxguard

Foxguard runs as a GitHub App check and is configured by .foxguard.yml. Existing high-severity findings are tracked in .foxguard/baseline.json so new findings can be separated from legacy debt. Secret scanning uses .foxguard/secrets-baseline.json.

Local Checks

Useful local equivalents before opening a pull request:

cd server
go test ./...
go vet ./...
go build -o /tmp/microc2-server ./cmd
cd agent
cargo test --locked
cargo clippy --locked --all-targets
cargo build --locked