External/libvirt
1
0
Fork 0
mirror of https://gitlab.com/libvirt/libvirt.git synced 2024-12-22 13:45:38 +00:00
Code Issues Packages Projects Releases Wiki Activity
cd1e837c22
libvirt/docs/newreposetup.rst

132 lines
2.9 KiB
ReStructuredText
Raw Normal View History

docs: list settings required in creating a new git repo The libvirt project has alot of git repositories, and they must all be configured in the same way, more or less. This page documents the settings changes that I have made in GitLab and GitHub when configuring projects, both as a reminder for myself, and to help anyone else doing the same in future. Also included is info about the repo mirroring on the libvirt.org server. Reviewed-by: Andrea Bolognani <abologna@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2020-04-08 16:36:05 +00:00
===============================
Repository infrastructure setup
===============================
GitLab Configuration
====================
The `GitLab organization <https://gitlab.com/libvirt>`_ hosts the master copy
of all the libvirt Git repositories.
When creating a new repository the following changes to the defaults are
required under the **Settings** page:
* **General**
* **Naming, topics, avatar**
* *Project avatar*: upload ``docs/logos/logo-square-256.png``
* **Visibility, project features, permissions**
* *Packages*: disabled
* *Wiki*: disabled
* *Snippets*: disabled
* **Merge Requests**
* *Merge method*: Fast-forward merge
* *Merge options*: Enable 'delete source branch' option by default
* *Merge checks*: Pipelines must succeed
* **Merge request approvals**
* *Any eligible user*: Num approvals required == 1
* **Integrations**
* **Pipelines emails**
docs: update docs pointing to old mailing list addrs Reviewed-by: Ján Tomko <jtomko@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2023-10-27 09:59:02 +00:00
* *Recipients*: ``ci@lists.libvirt.org``
docs: list settings required in creating a new git repo The libvirt project has alot of git repositories, and they must all be configured in the same way, more or less. This page documents the settings changes that I have made in GitLab and GitHub when configuring projects, both as a reminder for myself, and to help anyone else doing the same in future. Also included is info about the repo mirroring on the libvirt.org server. Reviewed-by: Andrea Bolognani <abologna@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2020-04-08 16:36:05 +00:00
* **Repository**
* **Push rules**
* *Do not allow users to remove git tags with git push*: enabled
* *Commit message*: ``Signed-off-by:``
* *Branch name*: ``^(master|v.*-maint)$``
* **Mirroring repositories**
* *Git repository URL*: ``https://libvirtmirror@github.com/libvirt/$repo.git``
* *Mirror direction*: push
* *Password*: see ``/root/libvirt-mirror-github-api-token.txt`` on ``libvirt.org``
* **Protected branches**
docs: document protected branches and tags We need to prevent accidental deletion of release tags and maint branches. We need to ensure that shared CI runners are enabled on all repos. Reviewed-by: Andrea Bolognani <abologna@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2020-05-06 11:08:56 +00:00
* *Branch*: ``master`` and ``v*-maint``
docs: list settings required in creating a new git repo The libvirt project has alot of git repositories, and they must all be configured in the same way, more or less. This page documents the settings changes that I have made in GitLab and GitHub when configuring projects, both as a reminder for myself, and to help anyone else doing the same in future. Also included is info about the repo mirroring on the libvirt.org server. Reviewed-by: Andrea Bolognani <abologna@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2020-04-08 16:36:05 +00:00
* *Allowed to merge*: Developers + Maintainers
* *Allowed to push*: None (or Developers + Maintainers if MRs not used)
* *Require approval from code owners*: disabled
docs: document protected branches and tags We need to prevent accidental deletion of release tags and maint branches. We need to ensure that shared CI runners are enabled on all repos. Reviewed-by: Andrea Bolognani <abologna@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2020-05-06 11:08:56 +00:00
* **Protected tags**
* *Tag*: ``v*`` and any project specific tag formats like ``LIBVIRT_*`` or ``CVE*``
* *Allowed to create*: Developers + Maintainers
* **CI/CD**
* **Runners**
* *Shared runners*: Enable shared runners
docs: Document CIRRUS_GITHUB_REPO variable This needs to be set for every repository for Cirrus CI integration to work. Signed-off-by: Andrea Bolognani <abologna@redhat.com> Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
2020-06-10 16:11:04 +00:00
* **Variables**
* *Key*: ``CIRRUS_GITHUB_REPO``
* *Value*: ``libvirt/$repo``
* *Protect variable*: enabled
* *Mask variable*: disabled
* *Key*: ``CIRRUS_API_TOKEN``
* No need to set this at the project level: it's already set for the
libvirt organization and will be inherited from there.
docs: list settings required in creating a new git repo The libvirt project has alot of git repositories, and they must all be configured in the same way, more or less. This page documents the settings changes that I have made in GitLab and GitHub when configuring projects, both as a reminder for myself, and to help anyone else doing the same in future. Also included is info about the repo mirroring on the libvirt.org server. Reviewed-by: Andrea Bolognani <abologna@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2020-04-08 16:36:05 +00:00
GitHub configuration
====================
The `GitHub organization <https://github.com/libvirt>`_ hosts read-only
mirrors of all the libvirt Git repositories.
When creating a new repository the following changes to the defaults are
required under the **Settings** page:
* **Options**
* **Features**
* *Wikis*: disabled
* *Sponsorships*: disabled
* *Projects*: disabled
* **Manage access**
* Add the ``@committers`` team with the role "Write", which
grants the ``libvirtmirror`` user access to sync from GitLab.
* **Integrations**
* Check for *Repo Lockdown* (should be set automatically for all projects)
In the master git repository create a file `.github/lockdown.yml` to restrict
use of issue tracker and pull requests.
Reference in New Issue Copy Permalink