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

Files

Jamil 391150f0e1 chore(ci): Fix new issues in cd.yml (#4085 )

Fixes some issues encountered after the merge of #4049 

- Fix performance tests to only run using base_ref and head_ref to avoid
dependence on `main`
- Fixes some typos
- Prevents a catch-22 condition where breaking compatibility meant we
wouldn't be able to deploy production

2024-03-12 02:06:19 +00:00

build

chore(windows): Sign internal exe using beforeBundleCommand (#3994 )

2024-03-06 16:00:54 +00:00

nix

feat(snownet): timeout connections if we don't receive a candidate within 10s (#3790 )

2024-03-09 08:03:57 +00:00

tests

chore(ci): Fix new issues in cd.yml (#4085 )

2024-03-12 02:06:19 +00:00

gateway-docker-upgrade.sh

chore(ci): enforce shellscript formatting and style (#3679 )

2024-02-21 01:01:32 +00:00

gateway-systemd-install.sh

chore(devops): Make some vars optional in systemd install script (#4017 )

2024-03-06 17:18:25 -08:00

Makefile

chore(repo): Move other dotfiles to reduce directory size of root (#3780 )

2024-02-27 17:23:17 +00:00

README.md

chore: move markdown files into docs/ directory (#3773 )

2024-02-27 01:12:57 +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 -euo pipefail in general for dev and test scripts.
In Docker images and other minimal envs, stick to #!/bin/sh and simply set -eu.