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

Files

Reactor Scram c5aab6ebba test(windows client): Add stack trace printing to smoke test (#3813 )

Closes #3798 

- After the crash test, the Windows smoke test runs `minidump-stackwalk`
to print a stack trace:
https://github.com/firezone/firezone/actions/runs/8100801373/job/22139592883#step:11:770
- This acts as runnable documentation for getting stack traces on
Windows, and it should flunk the test if anything in the crash handling
to stack trace pipeline is broken
- I also updated the comment in the code since the minidump PR I was
waiting on was put into their newest release

2024-02-29 20:41:35 +00:00

build

refactor(ci): enable Linux do-nothing GUI builds (but not tests) in CI/CD, extract scripts for that (#3735 )

2024-02-23 17:57:39 +00:00

nix

chore: add nix scripts (#3771 )

2024-02-27 23:56:46 +00:00

tests

test(windows client): Add stack trace printing to smoke test (#3813 )

2024-02-29 20:41:35 +00:00

gateway-docker-upgrade.sh

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

2024-02-21 01:01:32 +00: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.