mirror of https://github.com/outbackdingo/firezone.git synced 2026-01-28 02:18:50 +00:00

Files

Thomas Eizinger a8aafc9e14 ci: use bencher.dev for continuous benchmarking (#5915 )

Currently, we have a homegrown benchmark suite that reports results of
the iperf runs within CI by comparing a run on `main` with the current
branch.

These comments are noisy because they happen on every PR, regardless of
the performance results. As a result, they tend to be skimmed over by
devs and not actually considered. To properly track performance, we need
to record benchmark results over time and use statistics to detect
regressions.

https://bencher.dev does exactly that. it supports various benchmark
harnesses to automatically collect benchmarks. For our case, we simply
use the generic JSON adapter to extract the relevant metrics from the
iperf results and report them to the bencher backend.

With these metrics in place, bencher can plot the results over time, and
alert us in the case of regressions using thresholds based on
statistical tests.

Resolves: #5818.

---------

Signed-off-by: Thomas Eizinger <thomas@eizinger.io>
Co-authored-by: Reactor Scram <ReactorScram@users.noreply.github.com>

2024-07-24 01:22:17 +00:00

build

ci: Don't clobber assets for published releases (#5352 )

2024-06-13 06:41:38 +00:00

nix

chore(nix): install android-tools in dev-shell (#5855 )

2024-07-12 14:27:39 +00:00

tests

ci: use bencher.dev for continuous benchmarking (#5915 )

2024-07-24 01:22:17 +00:00

firezone-client-gui-install.sh

docs: Update 'user guides' -> 'client apps' (#5940 )

2024-07-23 14:04:07 +00:00

gateway-docker-upgrade.sh

chore: remove test lib bash sourcing from customer-run scripts (#4753 )

2024-04-23 19:04:02 +00:00

gateway-systemd-install.sh

docs: GitHub releases -> Changelog (#5763 )

2024-07-05 13:19:43 -07:00

Makefile

chore(gui-client): release GUI Client 1.1.7 (#5897 )

2024-07-17 22:23:43 +00:00

README.md

chore(gui-client/linux): add install script and change group to firezone-client (#4879 )

2024-05-02 17:51:28 +00:00

README.md

Firezone shell scripts

This directory contains various shell scripts used for development, testing, and deployment of the Firezone product.

Developer Setup

We lint shell scripts in CI. To get your PR to pass, you'll want to ensure your local development environment is set up to lint shell scripts:

Install shfmt:
- brew install shfmt on macOS
- Install shfmt from https://github.com/mvdan/sh/releases for other platforms
Install shellcheck:
- brew install shellcheck on macOS
- sudo apt-get install shellcheck on Ubuntu

Then just lint and format your shell scripts before you commit:

shfmt -i 4 **/*.sh
shellcheck --severity=warning **/*.sh

You can achieve this more easily by using pre-commit. See CONTRIBUTING.

Editor setup

Vim (here's an example using ALE)
VSCode

Scripting tips

Use #!/usr/bin/env bash along with set -euox pipefail in general for dev and test scripts.
In Docker images and other minimal envs, stick to #!/bin/sh and simply set -eu.