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

Files

Reactor Scram d0f68fc133 test(gui-client): multi-process smoke test for GUI + IPC service (#5672 )

```[tasklist]
### Tasks
- [x] Check the GUI saves its settings file
- [x] Check the IPC service writes the device ID to disk
- [x] Check the GUI writes a log file (skipped - we already check if the exported zip has any files in it)
- [x] Run the crash file through `minidump-stackwalk`
- [x] Reach feature parity with the original smoke tests
- [x] Ready for review
- [x] Finish #5452
- [ ] Start on #5453 
```

2024-07-04 21:10:31 +00:00

build

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

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

nix

chore: update Nix scripts to at least build GUI client (#5423 )

2024-06-18 22:02:53 +00:00

tests

test(gui-client): multi-process smoke test for GUI + IPC service (#5672 )

2024-07-04 21:10:31 +00:00

firezone-client-gui-install.sh

docs(client): update Linux and Windows Client docs (#5007 )

2024-05-22 20:22:46 +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: Add more Gateway deploy examples (#5646 )

2024-07-02 19:59:04 +00:00

Makefile

chore: Bump clients to 1.1.2 for DNS record type forward (#5703 )

2024-07-04 01:31:26 +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.