From ab12c2ca96016e23bf84c297c706f7df0de6df8d Mon Sep 17 00:00:00 2001 From: Peder Bergebakken Sundt Date: Tue, 24 Jun 2025 23:09:45 +0200 Subject: [PATCH 1/2] maintainers/README.md: expand section on maintainer tooling Addresses https://github.com/NixOS/nixpkgs/issues/234293#issuecomment-3000177145 --- maintainers/README.md | 30 +++++++++++++++++++++++++++--- 1 file changed, 27 insertions(+), 3 deletions(-) diff --git a/maintainers/README.md b/maintainers/README.md index 2759b0aa7dc1..faa9a3a2cc9b 100644 --- a/maintainers/README.md +++ b/maintainers/README.md @@ -58,10 +58,34 @@ person as a reviewer, and then waiting a week for a reaction. The maintainer is welcome to come back at any time. -### Tools for maintainers +## Tools for maintainers -When a pull request is made against a package, OfBorg will notify the -appropriate maintainer(s). +When a pull request is made against a package, nixpkgs CI will notify the appropriate +maintainer(s) by trying to correlate the files the PR touches with the packages that need rebuilding. + +Maintainers can also invoke the [nixpkgs-merge-bot](https://github.com/nixos/nixpkgs-merge-bot) +to merge pull requests targeting packages they are the maintainer of, which satisfy the current +security [constraints](https://github.com/NixOS/nixpkgs-merge-bot/blob/main/README.md#constraints). +Examples: [#397273](https://github.com/NixOS/nixpkgs/pull/397273#issuecomment-2789382120) and [#377027](https://github.com/NixOS/nixpkgs/pull/377027#issuecomment-2614510869) + +New maintainers will automatically get invited to join the [NixOS/nixpkgs-maintainers](https://github.com/orgs/NixOS/teams/nixpkgs-maintainers) GitHub team. +By joining, you will get some triaging rights in the nixpkgs repository, like the ability to close and reopen issues made by others, and managing labels. +However, the GitHub team invite is usually only sent by email, and is only valid for one week! +Should it expire, please ask for a re-invite in the [GitHub org owners help desk Matrix channel](https://matrix.to/#/#org_owners:nixos.org). + +### Unofficial maintainer tooling + +[zh.fail](https://zh.fail/failed/overview.html) tracks all package build failures on `master` grouped by maintainer. + +[asymmetric/nixpkgs-update-notifier](https://github.com/asymmetric/nixpkgs-update-notifier) is a matrix +bot that scrapes the [nixpkgs-update logs](https://nixpkgs-update-logs.nix-community.org/) and notifies +you if nixpkgs-update/@r-ryantm fails to update any of the packages you've subscribed to. + +[repology.org](https://repology.org) tracks and compares the versions of packages between various package repositories, letting you know what packages may be out of date or insecure. +You can view which packages a specific maintainer maintains and subscribe to updates with atom/rss. Example: [repology.org/maintainer/pbsds](https://repology.org/maintainer/pbsds%40hotmail.com). + +[nixpk.gs/pr-tracker](https://nixpk.gs/pr-tracker.html) and [nixpkgs-tracker.ocfox.me](https://nixpkgs-tracker.ocfox.me/) +can visualize the release status of any nixpkgs pull request. ## Reviewing contributions From 129709a082920e9db7de7080d11b3354c905c855 Mon Sep 17 00:00:00 2001 From: Peder Bergebakken Sundt Date: Tue, 24 Jun 2025 23:11:08 +0200 Subject: [PATCH 2/2] maintainers/README.md: document expected commit title format for maintainer additions This is already in (i think) CONTRIBUTING.md, but repetition both legitimizes and is more discoverable. --- maintainers/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/maintainers/README.md b/maintainers/README.md index faa9a3a2cc9b..cb9ff4f36437 100644 --- a/maintainers/README.md +++ b/maintainers/README.md @@ -42,7 +42,7 @@ package's `meta.maintainers` list, and send a PR with the changes. If you're adding yourself as a maintainer as part of another PR (in which you become a maintainer of a package, for example), make your change to -`maintainer-list.nix` in a separate commit. +`maintainer-list.nix` in a separate commit titled `maintainers: add `. ### How to lose maintainer status