From 9ed793229ca8a988f49b2001b13d33f0edc0790d Mon Sep 17 00:00:00 2001 From: Graham Christensen Date: Wed, 15 Apr 2020 08:20:47 -0400 Subject: teams/maintainers list: show instructions for validating the contents --- lib/tests/maintainers.nix | 4 ++-- maintainers/maintainer-list.nix | 6 +++++- maintainers/team-list.nix | 5 ++++- 3 files changed, 11 insertions(+), 4 deletions(-) diff --git a/lib/tests/maintainers.nix b/lib/tests/maintainers.nix index d9d21ea74fbea..935d256d218d2 100644 --- a/lib/tests/maintainers.nix +++ b/lib/tests/maintainers.nix @@ -1,8 +1,8 @@ # to run these tests (and the others) # nix-build nixpkgs/lib/tests/release.nix { # The pkgs used for dependencies for the testing itself - pkgs -, lib + pkgs ? import ../.. {} +, lib ? pkgs.lib }: let diff --git a/maintainers/maintainer-list.nix b/maintainers/maintainer-list.nix index 5e8a93473213d..689503eb7a551 100644 --- a/maintainers/maintainer-list.nix +++ b/maintainers/maintainer-list.nix @@ -45,7 +45,11 @@ More fields may be added in the future, however, in order to comply with GDPR this file should stay as minimal as possible. - Please keep the list alphabetically sorted. + When editing this file: + * keep the list alphabetically sorted + * test the validity of the format with: + nix-build lib/tests/maintainers.nix + See `./scripts/check-maintainer-github-handles.sh` for an example on how to work with this data. */ { diff --git a/maintainers/team-list.nix b/maintainers/team-list.nix index 2ea345a652d29..1b96dce645ef8 100644 --- a/maintainers/team-list.nix +++ b/maintainers/team-list.nix @@ -19,7 +19,10 @@ More fields may be added in the future. - Please keep the list alphabetically sorted. + When editing this file: + * keep the list alphabetically sorted + * test the validity of the format with: + nix-build lib/tests/teams.nix */ { lib }: -- cgit 1.4.1