buildbtw software collection

Projects

This repo contains a bunch of software maintained by the buildbtw team. Check the respective directories for their READMEs.

• buildbtw-poc - the proof of concept buildbtw implementation
• arch-pkg-repo-updater - a tool to sync package repositories

Roadmap

1. ✅ Collect initial user stories
2. ✅ Build an exploratory PoC to discover unknown unknowns and validate the approach we've planned
3. ⚙️ Write RFC, outlining major components & architecture
4. ⚙️ Build and deploy MVP
5. Iterate on the MVP to improve the service, writing new RFCs and requirements as needed

Project Management

We're using the issue tracker for requirements and user stories. We're planning to use labels to allow filtering the issues:

• by need: "must", "should", "could", "won't"
• by effort: XL, L, M, S
• by scope: feature, bug, docs, refactor, ...

Issues are grouped using milestones. Prioritization happens through user stories which reflect our high-level goals.

Information on prior art, technical background, feedback from user interviews and other notes are gathered in the notes folder.

Documentation

• Architecture Overview
• PoC User Guide
• PoC Deployment
• Contribution Guide

Development

• Install Rust. It's recommended to work with the stable toolchain. With rustup:

rustup install stable
rustup default stable

• Install just (pacman -S just or cargo install just)
• Install sea-orm-cli (pacman -S sea-orm-cli)
• For license checking: Install reuse (pacman -S reuse)
• For security auditing: Install cargo-deny (pacman -S cargo-deny or cargo install cargo-deny)

Commands

There are a bunch of commands you can run at this level. Run just to view all of them.

Lints & Testing

• just ci-dev to check whether the repo as a whole would pass CI
• just licenses to check license compliance
• just check-dependencies to audit dependencies, e.g. for security vulnerabilities.
• just lint to run cargo fmt and cargo clippy
• just lint-fix to automatically fix lints and formatting
• just format to format the source code
• just test to run tests
• just watch-test to run tests and auto-rerun on code changes

Build & Development

• just build to build in debug mode
• just build-release to build in release mode
• just bench to run performance benchmarks
• just clean to remove build artifacts, caches, and temporary files