Compare commits

..

1 commit

2 changed files with 57 additions and 41 deletions

View file

@ -1,52 +1,68 @@
/*
List of Aux maintainers.
```nix
handle = {
# Required
name = "Your name";
forgejo = "forgejoUsername";
forgejoId = your-forgejo-id;
/* List of NixOS maintainers.
```nix
handle = {
# Required
name = "Your name";
# Optional, but at least one of email or matrix must be given
email = "address@example.org";
matrix = "@user:example.org";
# Optional, but at least one of email, matrix or githubId must be given
email = "address@example.org";
matrix = "@user:example.org";
github = "GithubUsername";
githubId = your-github-id;
keys = [{
fingerprint = "AAAA BBBB CCCC DDDD EEEE FFFF 0000 1111 2222 3333";
}];
};
```
keys = [{
fingerprint = "AAAA BBBB CCCC DDDD EEEE FFFF 0000 1111 2222 3333";
}];
};
```
where
where
- `handle` is the handle you are going to use in nixpkgs expressions,
- `name` is a name that people would know and recognize you by,
- `email` is your maintainer email address,
- `matrix` is your Matrix user ID,
- `forgejo` is your forgejo handle (as it appears in the URL of your profile page, `https://git.auxolotl.org/<userhandle>`),
- `forgejoId` is your forgejo user ID, which can be found at `https://git.auxolotl.org/api/v1/users/<username>`,
- `keys` is a list of your PGP/GPG key fingerprints.
- `handle` is the handle you are going to use in nixpkgs expressions,
- `name` is a name that people would know and recognize you by,
- `email` is your maintainer email address,
- `matrix` is your Matrix user ID,
- `github` is your GitHub handle (as it appears in the URL of your profile page, `https://github.com/<userhandle>`),
- `githubId` is your GitHub user ID, which can be found at `https://api.github.com/users/<userhandle>`,
- `keys` is a list of your PGP/GPG key fingerprints.
`handle == forgejo` is strongly preferred whenever `forgejo` is an acceptable attribute name and is short and convenient.
Specifying a GitHub account ensures that you automatically:
- get invited to the @NixOS/nixpkgs-maintainers team ;
- once you are part of the @NixOS org, OfBorg will request you review
pull requests that modify a package for which you are a maintainer.
If `forgejo` begins with a numeral, `handle` should be prefixed with an underscore.
```nix
_1example = {
forgejo = "1example";
};
```
`handle == github` is strongly preferred whenever `github` is an acceptable attribute name and is short and convenient.
Add PGP/GPG keys only if you actually use them to sign commits and/or mail.
If `github` begins with a numeral, `handle` should be prefixed with an underscore.
```nix
_1example = {
github = "1example";
};
```
To get the required PGP/GPG values for a key run
```shell
gpg --fingerprint <email> | head -n 2
```
Add PGP/GPG keys only if you actually use them to sign commits and/or mail.
!!! Note that PGP/GPG values stored here are for informational purposes only, don't use this file as a source of truth.
To get the required PGP/GPG values for a key run
```shell
gpg --fingerprint <email> | head -n 2
```
More fields may be added in the future, however, in order to comply with GDPR this file should stay as minimal as possible.
!!! Note that PGP/GPG values stored here are for informational purposes only, don't use this file as a source of truth.
When editing this file, please ensure that you have added yourself in alphabetical order of your handle.
More fields may be added in the future, however, in order to comply with GDPR this file should stay as minimal as possible.
When editing this file:
* keep the list alphabetically sorted, check with:
nix-instantiate --eval maintainers/scripts/check-maintainers-sorted.nix
* 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.
When adding a new maintainer, be aware of the current commit conventions
documented at [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md#commit-conventions)
file located in the root of the Nixpkgs repo.
*/
{ }
{
}

View file

@ -2,7 +2,7 @@
lib.makeOverridable (
# cgit example, snapshot support is optional in cgit
{ repo, rev, name ? "source-savannah.gnu.org-${repo}-${rev}"
{ repo, rev, name ? "source"
, ... # For hash agility
}@args: fetchzip ({
inherit name;