# bgt

Bitcoin Guix Tag Builder

## About

bgt is a tool to perform automated or semi-automated [Guix builds](https://github.com/bitcoin/bitcoin/blob/master/contrib/guix/README.md) of Bitcoin Core.

These can be manually initiated, or trigger when a new tag is detected via polling the GitHub API.

It can build, attest, and codesign tagged Bitcoin Core releases.

## Requirements

- You will need to install and setup Guix for Bitcoin Core by following Bitcoin Core's [INSTALL.md](https://github.com/bitcoin/bitcoin/blob/master/contrib/guix/INSTALL.md).
- (optional) For attesting (signing) you will need a GPG key configured in your default keyring.
- You will need a fork of the [bitcoin-core/guix.sigs](https://github.com/bitcoin-core/guix.sigs) repository.
  - For pull requests to this repository, you will need your GPG key to be in the guix.sigs [builder-keys](https://github.com/bitcoin-core/guix.sigs/tree/main/builder-keys) which can be done via a pull request.
- (optional) To use `--auto` mode (automatically open pull requests against guix.sigs) you will need a github token with the appropriate permissions (repo).

## Installation

To install bgt-builder, you need to have Rust and Cargo installed on your system. Then, you can install it either using Cargo:

```bash
cargo install bgt
```

Or from source:

```bash
git clone https://github.com/bitcoin-dev-tools/bgt-builder.git bgt
cd bgt
cargo install --path .
```

## Usage

After installation, you can use the `bgt` command to interact with the tool.

To see the available commands run:

```bash
bgt
```

### Setup

Run the setup wizard to configure bgt:

```bash
bgt setup
```

This will guide you through setting up your GPG key ID, signer name, and other necessary configurations.

### Build

Build a specific tag of Bitcoin Core:

```bash
bgt build <tag>
```

Replace `<tag>` with the specific version tag you want to build, e.g., `v27.1`.

### Attest

Attest to non-codesigned build outputs:

```bash
bgt attest <tag>
```

### Codesign

Attach codesignatures to existing non-codesigned outputs and attest:

```bash
bgt codesign <tag>
```

### Watch

Run a continuous watcher to monitor for new tags and automatically build them, optionally as a background daemon:

```bash
bgt watch start <--daemon>
```

Stop a background watcher daemon

```bash
bgt watch stop
```

This command will poll the GitHub API for new tags and automatically build, attest, and codesign new releases.

### Clean

Clean up Guix build directories while leaving caches intact:

```bash
bgt clean
```

### Show Config

View the current configuration settings:

```bash
bgt show-config
```

## Additional Options

- `--multi-package`: Use `JOBS=1 ADDITIONAL_GUIX_COMMON_FLAGS='--max-jobs=8'` for building. This can be added to any command.

## Logging

bgt uses environment variables for logging configuration. You can set the `RUST_LOG` environment variable to control the log level. For example:

```bash
RUST_LOG=debug bgt build v27.1
```

This will run the build command with debug-level logging.

## Contributing

Contributions to bgt are welcome! Please feel free to submit issues and pull requests on our GitHub repository.

## License

See [license](https://raw.githubusercontent.com/bitcoin-dev-tools/bgt-builder/master/LICENSE).

## Plans

- [x] implement Guix building
- [x] permit building a specified tag
- [x] enable signing
- [ ] add advanced GPG signing solutions (tbd)
- [ ] remove some dependencies