Developer ramp-up

Developer onboarding for local work on vaultline.

Table of contents

• Prerequisites
• Initial setup
• Test workflow
• Build workflow
• Site/docs workflow
• Release handoff expectations

Prerequisites

• Go 1.22+
• Python + MkDocs Material (for docs build)
• Ruby + Bundler (for Jekyll pages build)

Initial setup

./scripts/bootstrap-debian.sh

This installs core tooling and Smokey.

Test workflow

go test ./...
smokey --tests-dir tests.d

Use focused package tests first, then full suite before release prep.

Build workflow

Default build (compile + deb package):

./scripts/build.sh

Targeted builds:

./scripts/build.sh --compile
./scripts/build.sh --deb
./scripts/build.sh --site
./scripts/build.sh --clean --deb --site

Version bump during build:

./scripts/build.sh --deb --version X.Y.Z

Release guardrail:

• Do not bump versions directly on release branch.
• Perform version bump and release prep on develop via ./scripts/prepare-release.sh <X.Y.Z>.

Site/docs workflow

./scripts/build-site.sh
./scripts/serve-site.sh

build-site.sh produces site/ with Jekyll + MkDocs output.

Release handoff expectations

• Work on develop.
• Keep release-note snippets under site-src/release-notes/unreleased/.
• Hand off changes via PR/commit before running release scripts.
• Use Runbook (Project Workflow) for exact release sequence.