2023-05-19 17:01:20 +03:00
|
|
|
# flake-checker
|
|
|
|
|
|
|
|
|
|
```shell
|
2023-05-26 15:16:27 +03:00
|
|
|
nix run github:DeterminateSystems/flake-checker
|
2023-05-19 17:19:30 +03:00
|
|
|
|
|
|
|
|
# Or point to an explicit path
|
2023-05-26 15:16:27 +03:00
|
|
|
nix run github:DeterminateSystems/flake-checker /path/to/flake.lock
|
2023-05-19 17:02:42 +03:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Currently performs two checks:
|
|
|
|
|
|
2023-05-24 17:59:36 +03:00
|
|
|
- Checks that any explicit Nixpkgs Git refs are in this list:
|
|
|
|
|
- `nixos-22.11`
|
|
|
|
|
- `nixos-22.11-small`
|
2023-06-07 19:45:56 +03:00
|
|
|
- `nixos-23.05`
|
|
|
|
|
- `nixos-23.05-small`
|
2023-05-24 17:59:36 +03:00
|
|
|
- `nixos-unstable`
|
|
|
|
|
- `nixos-unstable-small`
|
|
|
|
|
- `nixpkgs-22.11-darwin`
|
2023-06-07 19:45:56 +03:00
|
|
|
- `nixpkgs-23.05-darwin`
|
2023-05-24 17:59:36 +03:00
|
|
|
- `nixpkgs-unstable`
|
|
|
|
|
- Checks that any Nixpkgs dependencies are less than 30 days old
|
|
|
|
|
|
|
|
|
|
### Telemetry
|
|
|
|
|
|
|
|
|
|
The goal of the Determinate Flake Checker is to help teams stay on recent and supported versions of Nixpkgs.
|
|
|
|
|
The flake checker collects a little bit of telemetry information to help us make that true.
|
|
|
|
|
|
|
|
|
|
Here is a table of the [telemetry data we collect][diagnosticdata]:
|
|
|
|
|
|
|
|
|
|
| Field | Use |
|
|
|
|
|
| -------------- | ------------------------------------------------------------------------------------------------------ |
|
|
|
|
|
| `distinct_id` | An opaque string which represents your project, by sha256 hashing repository and organization details. |
|
|
|
|
|
| `version` | The version of the Determinate Flake Checker. |
|
2023-06-07 18:49:23 +03:00
|
|
|
| `is_ci` | Whether the checker is being used in CI (e.g. GitHub Actions). |
|
2023-05-24 17:59:36 +03:00
|
|
|
| `disallowed` | The number of inputs using unsupported branches of Nixpkgs. |
|
|
|
|
|
| `outdated` | The number of inputs using outdated versions of Nixpkgs. |
|
|
|
|
|
| `non_upstream` | The number of inputs using forks of Nixpkgs. |
|
|
|
|
|
|
|
|
|
|
To disable diagnostic reporting, set the diagnostics URL to an empty string by passing `--no-telemetry` or setting `FLAKE_CHECKER_NO_TELEMETRY=true`.
|
|
|
|
|
|
|
|
|
|
You can read the full privacy policy for [Determinate Systems][detsys], the creators of the Determinate Nix Installer, [here][privacy].
|
|
|
|
|
|
|
|
|
|
[detsys]: https://determinate.systems/
|
|
|
|
|
[diagnosticdata]: https://github.com/DeterminateSystems/nix-flake-checker/blob/main/src/telemetry.rs#L29-L43
|
|
|
|
|
[privacy]: https://determinate.systems/privacy
|
