Procedure for adding an official project to GitLab
- Project name: archlinux-docker
- Type: MIGRATION
- Current location: https://github.com/archlinux/archlinux-docker
New repo checklist
If you want to add a new official project, here are some guidelines to follow:
- Evaluate whether the project can sit in the official GitLab Arch Linux group or whether it needs its own group. It only needs its own group if the primary development group is somehow detached from Arch Linux and only losely related (for instance: pacman)
After project creation, add the responsible people to the project and give them
Developerrole. The idea is to let these people mostly manage their own project while not giving them enough permissions to be able to misconfigure the project.
- If mirroring to github.com is desired, work through the GitHub.com mirroring checklist below and then return to this one.
- If the project needs a secure runner to build trusted artifacts, coordinate with the rest of the DevOps team and if found to be reasonable, assign a secure runner to a protected branch of the project.
If a secure runner is used, make sure the project's
.gitlab-ci.ymlspecifies one of
tags: secure-kvmdepending on required capabilities.
Make sure that the Push Rules in https://gitlab.archlinux.org/archlinux/arch-boxes/-/settings/repository
reflect these values:
Reject unsigned commits:
Do not allow users to remove tags with git push:
Check whether author is a gitlab user:
Prevent committing secrets to git:
- All of these should be activated by default as per group rules but it's good to check.
The Protected Branches in https://gitlab.archlinux.org/archlinux/my-example/-/settings/repository should specify
Allowed to mergeand
Allowed to pushas
Developers + Maintainers.
GitHub.com mirroring checklist
- If you want to mirror your repository "my-example" from gitlab.archlinux.org to the github.com/archlinux organization, you should create an empty project for your project at github.com/archlinux/my-example or if that's an existing repository, make sure that the current histories of the source and target repository are exactly the same.
- Go to https://gitlab.archlinux.org/archlinux/my-example/-/settings/repository and open Mirroring repositories.
Make sure it has these settings:
Git repository URL:
SSH public key
Only mirror protected branches:
A new entry will pop up which has a button titled
Copy SSH public key. Click that to copy the public key to your clipboard.
Log in as the
archlinux-githubtechnical user. This is important as otherwise pushes won't be associated correctly.
- Go to https://github.com/archlinux/my-example/settings/keys and add a new deploy key.
- Name it "gitlab.archlinux.org" so we know where it's from.
- Paste the public key you copied from GitLab earlier.
Allow write access.
Verify the push mirror works by click the
In the repository settings on GitHub's side you should disable a few things to clean up the project page:
- In the GitHub description of the mirrored project, append " (read-only mirror)" so that people know it's a mirror.
Environmentsfrom being shown on the main page.
- In the website field put the full url to the repository on our GitLab.
To upload designs, you'll need to enable LFS. More information