yudaike/openSUSE-release-tools
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
openSUSE-release-tools/CONTENTS.md
Stephan Kulow cc3734c88f Remove the origin operator and its user scripts 
The service is down for 2 years and more and it was unused ever since.
The idea just never took off (also because it was pretty late in the
cycle and leap wasn't developed much longer the way it used to when
the design for this was created).

For the next SLE/Leap it's just very, very unclear how it will look
like and I'm 99% sure it's not going to go back to old Leap. So the
whole operator needs more work and maintenance than the current team
has, so keep it in the git history only.
2022-02-22 09:22:09 +01:00

12 KiB
Raw Blame History

Contents

This document describes in detail the contents of this repository. It is still a work in progress, but do not hesitate to report if something is missing.

Overview

The repository contains a set of tools to aid in the process of building, testing and releasing (open)SUSE based distributions. The Tools section enumerates and describes all these tools, including links to documentation, source code and some information about where they are used.

Apart from these tools, the repository includes:

  • Some documentation in the docs directory.
  • A Python module called osclib which includes code that is shared by several tools. They are available in the osclib package.
  • A Docker-based tests suite. The Docker manifests and the Docker Compose files are located in the dist directory.
  • GoCD configuration files in gocd. GoCD is an open source CI/CD server that is used to deploy the bots on OBS.
  • Several systemd units: the Metrics instance makes use of them.

Tools

Most of these tools are available as packages for several distributions. Check the spec file in this repository or the devel project for further information.

For the time being, we have classified them into three different groups: command line tools, OBS bots and osc plugins. Bear in mind that the information in the following list might be wrong and incomplete.

Command Line Tools

Usually, the executables are renamed as osrt-NAME (e.g., osrt-announcer).

announcer

Generates email diffs summaries to announce product releases.

pkglistgen

Generates and updates OBS products for openSUSE and SLE. It generates package lists based on 000package-groups and puts them in 000product (resulting kiwi files) and 000release-packages (release package spec files).

container_cleaner

Clean old containers from a given project like openSUSE:Containers:Tumbleweed. Only those containers providing binaries to the latest five versions for each architecture are kept.

metrics

Generates insightful metrics from relevant OBS and annotation data, based on InfluxDB and Grafana. See https://metrics.opensuse.org/.

metrics-access

Ingests download.opensuse.org Apache access logs and generates metrics. It is composed of a PHP script and a set of systemd units.

totest-manager

Releases distribution snapshots to openQA and publishes if the result is positive.

bugowner

Manages bugowner information

  • Sources: bugowner.py
  • Documentation: --
  • Package: openSUSE-release-tools
  • Usage: ?

bs_mirrorfull

Mirrors repositories from the build service to a local directory.

  • Souces: bs_mirrorfull
  • Documentation: --
  • Package: openSUSE-release-tools
  • Usage: Used by other tools like pkglistgen or repocheck

biarchtool

Manages biarch packages

  • Source: biarchtool.py
  • Documentation: --
  • Package: openSUSE-release-tools
  • Usage: ?

build-fail-reminder

Sends e-mails about packages failing to build for a long time.

checknewer

Checks if all packages in a repository are newer than all other repositories.

  • Sources: checknewer.py
  • Documentation: --
  • Package: openSUSE-release-tools
  • Usage: ?

deptool

Assists in debugging dependencies

  • Sources: deptool.py
  • Documentation: --
  • Package: openSUSE-release-tools
  • Usage: ?

requestfinder

Allows to retrieve requests from OBS with quite elaborated queries.

  • Sources: requestfinder.py
  • Documentation: --
  • Package: openSUSE-release-tools
  • Usage: ?

create_staging

Scripts and templates to create staging projects.

Bots

check_maintenance_incidents

Handles maintenance incident requests

origin-manager

Keeps track of from what project a package originates, submit updates, review requests to detect origin changes, and enforce origin specific policies like adding appropriate reviews

staging-bot

Assists in management of staging projects.

legal-auto

Makes automatic legal reviews based on the legaldb API

  • Sources: legal-auto.py
  • Documentation: --
  • Package: openSUSE-release-tools
  • Usage: gocd

check_tags_in_requests

Checks that a submit request has correct tags specified.

abichecker

Checks ABI compatibility in OBS requests.

  • Sources: abichecker
  • Documentation: --
  • Package: openSUSE-release-tools-abichecker
  • Usage: gocd?

check_source_in_factory

Checks if the sources of a submission are either in Factory or a request for Factory with the same sources exist. Not used as a standalone bot anymore, but called internally from check_tags_in_requests.

openqa-maintenance

OpenQA stuff, not sure about the details.

repo-checker

Inspects built RPMs from staging projects.

OSC Plugins

osc-check_source.py

Checks for usual mistakes and problems in the source packages submitted by users. Used also as review bot that assigns reviews (?).

osc-origin.py

Tools for working with origin information.

osc-cycle.py

Helps with OBS build cycles visualization. See the openSUSE:Factory/standard example.

compare_pkglist.py

Compares packages status between two projects. It determines which project has the newer version of a package, shows the diff, etc. Additionally, it is able to create a submit request from SOURCE to TARGET in case packages are different.

  • Sources: compare_pkglist.py
  • Documentation: --
  • Package: openSUSE-release-tools
  • Usage: ???

staging

Manages staging projects.

fcc_submitter.py

The FactoryCandidates projects are used to determine whether a new package in Factory does build in the Leap version under development (see openSUSE:Leap:15.2:FactoryCandidates as example). This tool helps to manage this project by creating/updating project links for new packagers and creating SR from FactoryCandidates to the Leap project on successful builds.

  • Sources: fcc_submitter.py
  • Documentation: --
  • Package: openSUSE-release-tools
  • Usage: manually

issue-diff.py

Compares packages from a project against factory for differences in referenced issues and presents changes to allow whitelisting before creating Bugzilla entries.

  • Sources: issue-diff.py
  • Documentation: --
  • Package: openSUSE-release-tools
  • Usage: ???