bob

command module
v0.0.0-...-b7a57f2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 14, 2024 License: Apache-2.0 Imports: 3 Imported by: 0

README

Write Once, Build Once, Anywhere


Latest Release GoDoc Build Status

Bob is a high-level build tool for multi-language projects.

Use it to build codebases organized in multiple repositories or in a monorepo.

When to consider using Bob?

  • You want a pipeline which runs locally and on CI.
  • You want remote caching and never having to do the same build twice.
  • You want to get rid of "Works on My Machine".
  • You like Bazel and its features but think it's too complex.
  • You want a build system which keeps frontend tooling functional.

Getting Started

Docs | Install

Installing From Source

If you want to go wild, and have Go 1.17 or later installed, the short version is:

git clone https://github.com/benchkram/bob
cd bob
go install

For shell autocompletion (bash and zsh supported) add source <(bob completion) to your .bashrc/.zshrc.

How it works

Bob generates its internal build graph from tasks described in a bob.yaml file (usually referred to as "Bobfile"). Each build step is executed in a sandboxed shell only using the given dependencies required from the nix package manager.

The basic components of a build task are:

  • input: Whenever an input changes, the task's commands need to be re-executed.
  • cmd: Commands to be executed
  • target: Files, directories or docker images created during execution of cmd
  • dependencies Dependencies managed by the Nix package manager

Example of a bob.yaml file:

nixpkgs: https://github.com/NixOS/nixpkgs/archive/nixos-23.11.tar.gz
build:
  build:
    input: "*"
    cmd: go build -o ./app
    target: ./app
    dependencies: [go]

Multiline sh and bash commands are entirely possible, powered by mvdan/sh.

Comparisons

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
bob
pkg
add
ctl
filepathxx
From https://github.com/klauspost/filepathx/blob/master/filepathx.go
From https://github.com/klauspost/filepathx/blob/master/filepathx.go
nix
store-client/generated
Package generated provides primitives to interact with the openapi HTTP API.
Package generated provides primitives to interact with the openapi HTTP API.
test
tui-example
tui

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL