A small and light tool to help with FreeBSD Ports CI (Continuous Integration)
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Bernhard Fröhlich b7bac70b65
Fix config property values for Status API
3 週之前
assets Fix pre wrapping for long lines 2 月之前
static Fix pre wrapping for long lines 2 月之前
templates Fix job.BaseURL to have the full URL to the jobs directory 2 月之前
work Fix clean targets to have multiple names so it can be called more than once per build 2 月之前
.drone.yml Simplify drone config 3 月之前
LICENSE Update copyright year and name 2 月之前
README.md Update feature list in README 1 月之前
caronade.yaml Fix config property values for Status API 3 週之前
go.mod Add support for gzip compression to our http server 5 月之前
go.sum Add support for gzip compression to our http server 5 月之前
main.go Update job ID format for better readability 2 月之前

README.md

caronade

Go Report Card Chat on IRC

A small and light tool to help with FreeBSD Ports CI (Continuous Integration).

Caronade will automatically create build jobs using poudriere and portlint whenever you push changes to your Git based ports repository.

Main features

  • Simple to setup and maintain
  • GitHub and Gitea integration (Webhooks, Status API)
  • Poudriere support for building
  • Portlint support to verify port files
  • EMail notifications
  • Built-in webserver for Web UI and logfiles with HTTPS support

Getting Started

Caronade has an embedded HTTP(S) server which can receive Webhooks and shows your build status and build logs. It will execute a Makefile which runs the poudriere build so it expects that you have poudriere running successfully on the same machine. Each poudriere jail needs to have his own portstree to be able to run jobs in parallel.

Requirements

  • git repository (GitHub or Gitea) with your ports
  • poudriere on ZFS
  • caronade needs to be reachable from the Internet

Installation

There is a FreeBSD port available as ports-mgmt/caronade.

pkg install caronade

Configuration

Edit /usr/local/etc/caronade/caronade.yaml as needed.

GitHub Setup: Webhook

Create a new repository which only contains your ports (avoid forking the full FreeBSD portstree) on GitHub.

A webhook needs to be created which does a HTTP POST request to your caronade daemon.

Create the webhook from the repository webinterface

github: repository settings -> webhooks -> add webhook
  payload url: baseurl from caronade
  content type: application/json
  secret: same as below
  events: Just the push event

Test the webhook by pushing a commit to the repository.

GitHub Setup: Status API (optional)

If you want caronade to integrate into the GitHub Webinterface for your repository then you need to create an GitHub API Token for that.

github: user settings -> developer settings -> personal access tokens -> repo:status

The token and API URL needs to be set in caronade.yaml.

Usage

Caronade parses the commit message and expects all commit messages to start with category/portname which it will use to generate build jobs. If the commit message contains a line CI: yes|no build jobs will be generated for all or no queues. Per default if no such line is found build jobs are generated for all queues specified in default_queues in caronade.yaml.

FAQ

Why caronade?

FreeBSD Ports are a great and huge collection of 3rd party sofware. For people working with ports it is very monotonic to do a lot of build testing to verify that your changes/new port builds fine in many different combinations (FreeBSD versions, architectures, Port options etc.).

Caronade does the testing for you while you continue with your work.

Is this redports?

Redports was an attempt to run a fully hosted FreeBSD Ports building service for everyone. Sadly it was also very complex, hard to maintain and time consuming to operate which is why it was discontinued after a few years. Caronade is an attempt to build a similar tool but as simple as possible and for your own poudriere machine. So caronade is not a fully hosted service.