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

Files

Thomas Eizinger 2c26fc9c0e ci: lint Rust dependencies using cargo deny (#7390 )

One of Rust's promises is "if it compiles, it works". However, there are
certain situations in which this isn't true. In particular, when using
dynamic typing patterns where trait objects are downcast to concrete
types, having two versions of the same dependency can silently break
things.

This happened in #7379 where I forgot to patch a certain Sentry
dependency. A similar problem exists with our `tracing-stackdriver`
dependency (see #7241).

Lastly, duplicate dependencies increase the compile-times of a project,
so we should aim for having as few duplicate versions of a particular
dependency as possible in our dependency graph.

This PR introduces `cargo deny`, a linter for Rust dependencies. In
addition to linting for duplicate dependencies, it also enforces that
all dependencies are compatible with an allow-list of licenses and it
warns when a dependency is referred to from multiple crates without
introducing a workspace dependency. Thanks to existing tooling
(https://github.com/mainmatter/cargo-autoinherit), transitioning all
dependencies to workspace dependencies was quite easy.

Resolves: #7241.

2024-11-22 00:17:28 +00:00

build

chore(ci): build RPM package (#7190 )

2024-11-01 18:06:09 +00:00

nix

ci: lint Rust dependencies using cargo deny (#7390 )

2024-11-22 00:17:28 +00:00

tests

feat(connlib): support DNS over TCP (#6944 )

2024-10-18 03:40:50 +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

chore: set simpler default log filters (#7028 )

2024-10-14 18:54:36 +00:00

Makefile

chore(gui-client): publish version 1.3.13 (#7346 )

2024-11-15 06:52:38 +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.