mirror of https://github.com/outbackdingo/firezone.git synced 2026-01-27 18:18:55 +00:00

Files

Thomas Eizinger 7703daea2e chore(nix): remove env vars from flake (#6058 )

This messes with the build cache because the locally run rust-analyzer
doesn't recognise those variables and thus keeps poisoning the cache. If
other Nix users want `mold`, they should set it up in their user
configuration.

2024-07-26 19:51:47 +00:00

build

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

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

nix

chore(nix): remove env vars from flake (#6058 )

2024-07-26 19:51:47 +00:00

tests

fix(headless-client/linux): only notify systemd that we're up after Resources are available (#6026 )

2024-07-26 18:53:08 +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.