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

Files

Thomas Eizinger 40f0609d90 ci: lint GitHub workflows with actionlint (#9590 )

[`actionlint`](https://github.com/rhysd/actionlint) is a static analysis
tool for GitHub workflows and actions. It detects various issues ahead
of time and runs shellcheck on all `run` blocks. It is worth noting that
this does **not** lint the contents of composite actions so we still
need to be vigilant when working with those.

2025-06-24 08:05:10 +00:00

build

fix(ci): lock xcode major (#9585 )

2025-06-19 09:21:58 -07:00

nix

ci: lint GitHub workflows with actionlint (#9590 )

2025-06-24 08:05:10 +00:00

tests

feat(gui-client): polish Linux bundling (#9181 )

2025-05-20 15:34:16 +00:00

upload

ci: Add fixes for upload script (#7588 )

2024-12-29 19:08:08 +00:00

bump-versions.sh

chore: bump gui, apple, gateway (#9586 )

2025-06-19 12:29:46 -07:00

create-publish-pr.sh

ci: automatically create PR after publishing release (#9556 )

2025-06-18 06:17:18 +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

feat(connlib): only conditionally hash firezone ID (#9633 )

2025-06-24 07:05:48 +00:00

gateway-systemd-install.sh

docs(kb): update path to Gateway to new location (#8794 )

2025-04-16 13:20:28 +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.