Package Maintainer guidelines - ArchWiki

Jump to content
Toggle the table of contents

# Package Maintainer guidelines

3 languages

- 日本語
- Português
- 中文（简体）

From ArchWiki

Related articles

- Arch User Repository
- DeveloperWiki:How to be a packager
- DeveloperWiki:Building in a clean chroot
- GnuPG
- OpenPGP

Package Maintainers are Arch Linux staff members charged with keeping the AUR in working order. They maintain popular packages (communicating with and sending patches upstream as needed), and vote in administrative matters. A Package Maintainer is elected from active community members by current Package Maintainers in a democratic process. Package Maintainers are the only members who have a final say in the direction of the AUR.

The Package Maintainers are governed using the Package Maintainer bylaws

## TODO list for new Package Maintainers

1. Read this entire wiki article.
2. Read the Package Maintainer Bylaws.
3. Make sure your account details on the AUR are up-to-date.
4. Ask one of your sponsors to give you the Package Maintainer status on the AUR.
5. Remind a bureaucrat to add your wiki account to the Arch Linux Package Maintainers group.
6. Remind a BBS admin to change your account on forums.
7. Ask one of your sponsors for the #archlinux-staff and #archlinux-packaging keys and join us in the channels (this is not mandatory, but a great way of getting to know parts of the team and collaborate).
   - If you need a bouncer, ask heftig for a Matrix invite.
   - If you want an `@archlinux/package-maintainer/username` cloak, ask our group contacts to get you one.
8. Ask one of your sponsors to create a ticket in the infrastructure repository issue tracker (using the `Onboarding` template) and provide them with the following information:
   - An SSH public key. If you do not have one, follow SSH keys#Generating an SSH key pair to create one.
   - A username which will be used for your SSO account and for your (to be created) `@archlinux.org` email address.
   - Your full name.
   - Your (personal) e-mail address and a valid PGP public key ID for it, which will be used to provide the initial password for the developer interface (archweb) to you and which will be linked to your (to be created) SSO account.
   - Whether your private or your (to be created) `username@archlinux.org` email address should be used for the non-public mailing lists and be allowed to post to the arch-dev-public mailing list.
9. Set the password for your `@archlinux.org` e-mail address by following DeveloperWiki:Staff Services#Email.
10. Create a PGP key pair for package signing by following the workflow for adding a new packager key (using your new `username@archlinux.org` address as uid).
11. Ask one of your sponsors to create a ticket in the archlinux-keyring repository issue tracker (using the `New Packager Key` template) in order to have your PGP key signed by (at least) three main key holders.
12. Install the devtools package.
13. Configure your private ssh key for `repos.archlinux.org`.
14. Ssh to `yourname@repos.archlinux.org` (once you have permissions).
15. Start contributing!

## The Package Maintainer and the AUR

The Package Maintainers should also make an effort to check package submissions in the AUR for malicious code and good PKGBUILDing standards. In around 80% of cases the PKGBUILDs in the AUR are very simple and can be quickly checked for sanity and malicious code by the Package Maintainer team.

Package Maintainers should also check PKGBUILDs for minor mistakes, suggest corrections and improvements. The Package Maintainer should endeavor to confirm that all packages follow the Arch Packaging Guidelines/Standards and in doing so share their skills with other package builders in an effort to raise the standard of package building across the distribution.

Package Maintainers are also in an excellent position to document recommended practices.

### Rewriting git history

In some cases rewriting the history of an AUR repository is required, for example when a user inadvertently uses their legal name in a published commit. This can be automated with git-filter-branch(1).

To force push the new history, forward the `AUR_OVERWRITE=1` environment variable to git-push(1).

In detail this includes adding `SendEnv AUR_OVERWRITE` to your AUR SSH config and setting the env var on your push command: `AUR_OVERWRITE=1 git push --force`. See [1] for details.

Warning: It is recommended to create a backup of the repository before rewriting history.

Modify committer or author identity

Install git-filter-repo and run:

    $ git-filter-repo --name-callback 'return name.replace(b"Old name", b"New name")' --email-callback 'return email.replace(b"old@email.com", b"new@email.com")'

Tip: If the username contains special characters you may need to encode the strings `name.replace("Bás Ssze".encode("utf-8"), b"newname")'`

Alternatively, use `git filter-branch --env-filter` with the `GIT_AUTHOR_NAME`, `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_NAME` and `GIT_COMMITTER_EMAIL` environment variables. For example:

    git filter-branch --env-filter '
    if test "$GIT_AUTHOR_EMAIL" = "lepetit@prince.com"; then
      GIT_AUTHOR_EMAIL=user@users.noreply.github.com
    fi
    if test "$GIT_AUTHOR_NAME" = "Antoine de Saint-Exupéry"; then
      GIT_AUTHOR_NAME=user
    fi'

Note: git-log(1) only displays the git author by default. Use `git log --pretty=fuller` to display the author and committer.

### Handling AUR requests

This article or section needs expansion.

Reason: This list is incomplete for now and should be expanded. (Discuss in Talk:Package Maintainer guidelines)

Package Maintainers should periodically check the requests filed on the AUR. For that there are some generic rules what to check for each request type:

Orphan request

- check if the request is older then 14 days (the date column turns red in the overview) (you cannot accept it before that anyway)
- check if there was no update to the package itself (commit or release) done in the past 14 days
- check if there was no comment from the AUR package maintainer done in the past 14 days

If all of the above points are true then you can accept the Orphan Request.

## The Package Maintainer and extra, guidelines for package maintenance

### Rules for packages entering the extra repository

- A package must not already exist in any of the Arch Linux repositories. You should take necessary precautions to ensure no other packager is in the process of promoting the same package. Double-check the AUR package comments, read the latest subject headings in aur-general, search all projects in the bugtracker[dead link 2024-01-13 ⓘ], grep the git-log(1), and send a quick message to the private packaging IRC channel.
- Pacman wrappers, as a special exception, will never be permitted. If wanting to otherwise add an AUR helper, write an email to `arch-dev-public` with the proposed addition, and respect any objections provided by team members.

The factual accuracy of this article or section is disputed.

Reason: The following rule is arbitrary and not enforced in practice. The next two points need to be adjusted as well. (Discuss in Talk:Package Maintainer guidelines)

- Only "popular" packages may enter the repository, as defined by 1% usage from pkgstats or 10 votes on the AUR.
- Automatic exceptions to this rule are:
  - i18n packages
  - accessibility packages
  - drivers
  - dependencies of packages who satisfy the definition of popular, including makedeps and optdeps
  - packages that are part of a collection and are intended to be distributed together, provided a part of this collection satisfies the definition of popular
- Any additions not covered by the above criteria must first be proposed on the aur-general mailing list, explaining the reason for the exemption (e.g. renamed package, new package). The agreement of three other Package Maintainers is required for the package to be accepted into extra. Proposed additions from Package Maintainers with large numbers of "non-popular" packages are more likely to be rejected.
- Package Maintainers are strongly encouraged to move packages they currently maintain from extra if they have low usage. No enforcement will be made, although resigning Package Maintainers packages may be filtered before adoption can occur.
- It is good practice to always bump the pkgrel by 1 (in other words, set it to n + 1) when promoting a package from AUR. This is to facilitate automatic updates for those who already have the package installed, so that they may continue to receive updates from the official channel. Another positive effect of this is that users are not warned that their local copy is newer, as is the case if a packager does reset the pkgrel to 1.

### Accessing and updating the repository

See the packager guide.

### Disowning packages

If a Package Maintainer cannot or does not want to maintain a package any longer, a notice should be posted to the AUR Mailing List, so another package maintainer can maintain it. A package can still be disowned even if no other Package Maintainer wants to maintain it, but the Package Maintainers should try not to drop many packages (they should not take on more than they have time for). If a package has become obsolete or is not used any longer, it can be removed completely as well.

If a package has been removed completely, it can be uploaded once again (fresh) to the AUR, where a regular user can maintain the package instead of the Package Maintainer.

### Moving packages from the AUR to extra

Follow the normal procedures for adding a package to extra using the instructions in the Packager guide, but remember to delete the corresponding package from the AUR!

### Moving packages from extra to the AUR

Remove the package using the instructions in the Packager Guide and upload your source to the AUR.

### Moving packages from extra-testing to extra

Move the package from the extra-testing to the extra repository using the instructions in the packager guide.

### Remote build on build.archlinux.org

Warning: The following procedures defeats the Web Of Trust model: a user with root access to PKGBUILD.com could alter the package and/or the signature before it gets published.

Package Maintainers and Developers can connect to build.archlinux.org via SSH to, among others, build packages using the devtools. This has numerous advantages over a local setup:

- Builds are fast and network speed is high.
- The environment needs setup only once.
- Your local system need not be Arch Linux.

The process is similar to that of a local setup with devtools. Your GnuPG private is required for signing but you do not want to upload it for obvious security reasons. As such, you will need to forward the GnuPG agent socket from your local machine to the server: this will allow you to sign packages on the build server without communicating your key. This also means that we need to disable the agent on the server before we can run anything.

First, connect to build.archlinux.org and disable

    $ ssh build.archlinux.org
    $ systemctl --user mask gpg-agent.service

Make sure gpg-agent is not running (`systemctl --user stop gpg-agent.service`). At this point, make sure that no sockets exist in the folder pointed by `gpgconf --list-dir socketdir`. If they do, remove them or log out and in again. If you have a custom $GNUPGHOME (eg. to move it to `~/.config/gnupg`), you will need to unset that, as it is not possible in gnupg to set the homedir without setting the socketdir. On build.archlinux.org, `StreamLocalBindUnlink yes` is set in `sshd_config`, therefore removing the sockets manually on logout is not necessary.

While the PGP private keys remain on your local machine, the public keys must be on the build server. Export your public ring to the build server, e.g. from you local machine

    $ scp ~/.gnupg/pubring.gpg build.archlinux.org:~/.gnupg/pubring.gpg

SSH is required to checkout and commit to the Git repository. You can either set up a new SSH key pair on the server (it is highly discouraged to put your local private key on a server for security reasons) or reuse your local keys via socket forwarding. If you opt for the latter, make sure to disable ssh-agent on the build server if you had enabled it previously (it is not running by default).

Configure you build environment on the build server:

    ~/.makepkg.conf

    PACKAGER="John Doe <john@doe.example>"
    ## Optional
    PKGDEST="/home/johndoe/packages"
    SRCDEST="/home/johndoe/sources"
    SRCPKGDEST="/home/johndoe/srcpackages"
    LOGDEST="/home/johndoe/logs"
    ## If your PGP key is not the default, specify the right fingerprint:
    GPGKEY="ABCD1234..."

Warning: Forwarding your gpg-agent socket to a remote machine makes it possible for anyone with root access to that system to use your unlocked GPG credentials. To circumvent this issue, we need to disable passphrase caching.

Disable passphrase caching with the following settings:

    gpg-agent.conf

    default-cache-ttl 0
    max-cache-ttl 0

Because we will want to keep our usual GPG agent running with its current settings, we are going to run another GPG agent dedicated to the task at hand. Create a `~/.gnupg-archlinux` folder and symlink everything from `~/.gnupg` there, except `~/.gnupg/gpg-agent.conf`. Configure the new GPG agent:

    ~/.gnupg-archlinux

    extra-socket /home/doe/.gnupg-archlinux/S.gpg-agent.extra
    default-cache-ttl 0
    max-cache-ttl 0
    pinentry-program /usr/bin/pinentry-gtk-2

The `gpg-agent-extra.socket` will be forwarded to build.archlinux.org.

Start the dedicated agent with

    $ gpg-agent --homedir ~/.gnupg-archlinux --daemon

Connect with:

    $ ssh -R REMOTE_SSH_AUTH_SOCK:$SSH_AUTH_SOCK -R /run/user/REMOTE_UID/gnupg/S.gpg-agent:/home/doe/.gnupg-archlinux/S.gpg-agent.extra build.archlinux.org

or, if using GnuPG as your SSH agent:

    $ ssh -R /run/user/REMOTE_UID/gnupg/S.gpg-agent.ssh:/run/user/LOCAL_UID/gnupg/S.gpg-agent.ssh -R /run/user/REMOTE_UID/gnupg/S.gpg-agent:/home/doe/.gnupg-archlinux/S.gpg-agent.extra build.archlinux.org

Replace `REMOTE_UID` and `LOCAL_UID` by your user identifier as returned by `id -u` on the build server and locally, respectively. If using ssh-agent, replace `REMOTE_SSH_AUTH_SOCK` by the path to the SSH socket on the remote host (it can be anything).

You can make the forwarding permanent for that host. For instance with gpg-agent.ssh:

    ~/.ssh/config

    Host build.archlinux.org
      RemoteForward /run/user/REMOTE_UID/gnupg/S.gpg-agent /run/user/%i/gnupg/S.gpg-agent.extra
      RemoteForward /run/user/REMOTE_UID/gnupg/S.gpg-agent.ssh /run/user/%i/gnupg/S.gpg-agent.ssh

Again, replace `REMOTE_UID` with the user UID on the build server.

From then on, the procedure should be exactly the same as a local build:

    $ ssh build.archlinux.org
    $ pkgctl repo clone existing-package
    $ ...

Note: pinentry-curses might not work with socket forwarding. If it fails for you, try using a different pinentry.

## TODO list retiring a Package Maintainer

When a Package Maintainer resigns the following list has be followed, these steps do not apply when a Package Maintainer resigns but is still a Developer.

1. All packages packaged by the retiree should be resigned (so rebuild). Packages packaged by the retiree can be found in Archweb https://archlinux.org/packages/?sort=&q=&packager=$packager&flagged= where packager is the username on Archweb.
2. The account of the retiree should be disabled on Archweb and added to the 'Retired Package maintainers' group. The retiree should be removed from the 'Package Maintainers' and the repository permissions should be reduced to none.
3. The shell access to our servers should be disabled. (notably repos.archlinux.org, pkgbuild.com)
4. The GPG key should be removed and a new archlinux-keyring package should be pushed to the repos. Create bug reports in the keyring project to remove the keys of the retired Package Maintainers.
5. Remove the Package Maintainer group from their AUR account.
6. A bureaucrat should remove their wiki account from the Arch Linux Package Maintainers group.
7. A BBS admin should change their account on forums.

Categories:

- Package development
- OpenPGP

Hidden categories:

- Pages or sections flagged with Template:Expansion
- Pages with dead links
- Pages or sections flagged with Template:Accuracy