mgarepo(8)

📦 version 1.13.2, in fedora 43, fedora 44

💖 mgarepo(8) — bestie edition 💖

okay so you wanna manage RPM package sources in a Subversion repo? This is the girl. Manual name: mgarepo. Section 8. Let's GO. 🦋

✨ NAME ✨

mgarepo — Package sources repository management tool. 💅

🌸 SYNOPSIS 🌸

mgarepo command [options] [arguments]

that's it. that's the whole shape of it. a command, some options, some arguments. iconic. 🎀

🫶 DESCRIPTION 🫶

So mgarepo is the tool you use to manage RPM packages in a subversion repository. fr fr. It's the one that:

  • creates stuff
  • tags releases
  • generates .src.rpm
  • generates changelogs
  • requests new package releases for build

Mostly it's just a glow-up interface over svn(1) commands plus some small task scripts that run on the build system side over ssh(1). no cap.

Most of the mgarepo commands operate on a given package URL — and you can totally omit those URLs when the configuration option repository is set. lowkey convenient.

And if you want the detailed tea on any command? Just run:

mgarepo <command> --help

🌈 BASIC USAGE 🌈

🧚 Setup

Real talk: mgarepo does not handle the authentication interface that svn uses. So you usually need to set up ssh-agent(1) if your repository access method is over SSH (svn+ssh:// URLs) — or else do some simple operation just to get yourself an authentication token. 💀

For more info about setting up ssh-agent, see:

https://wiki.mageia.org/en/Packagers_ssh

Users who don't have an ssh account on the default repository URL can set the option mirror pointing to a non-authenticated, read-only repository — like this one right here:

svn://svn.mageia.org/svn/packages

🍓 Examples

Let's get into it, bestie. 💅

  • mgarepo co foo — Obtains a working copy of the package foo. 🎀
  • mgarepo co 1/mutt — Obtains a working copy of the package mutt of from the 1 branch. 🦋
  • mgarepo co hplip -k 5 — Obtains a working copy of the package hplib of from the 5 branch and backport directory. (yes, it says hplib, we're keeping it exactly as written, don't @ me) 😭
  • mgarepo ci — Commits pending changes in the working copy. ✨
  • mgarepo submit foo -r 12345 — Requests the package foo in the revision 12345 to be built and, if successful, to be uploaded to the RPMs repository. 🔥
  • mgarepo submit foo -r 12345 -t 1 --define section=core/testing — Will submit the package foo and, upon successful build will have its RPMs placed inside the core/testing media of the 1 repository. 👑
  • mgarepo submit — submit run without parameters will use package name and revision found in the working copy in the current directory. main character energy, honestly. 💖
  • mgarepo obsolete foo — Move the package foo from cauldron/foo to obsolete/foo on svn. 🫶

👑 COMMANDS 👑

For detailed help on commands run mgarepo <command> --help. periodt.

  • co — checkout a package 🌸
  • ci — commit changes 💅
  • submit — submit a package in a given revision for build and release 🔥
  • sync — add-remove all file changes from the .spec ✨
  • maintdb — get/set package maintainers informations 🎀
  • putsrpm — import a source package to the repository 🦋
  • getspec — print the spec 📄
  • rpmlog — print the RPM changelog generated from SVN 🧚
  • getsrpm — create the source RPM 💜
  • create — create the structure of a new package 🌈
  • changed — show changes not submitted 👀
  • authoremail — print the e-mail of a given svn author 📧
  • switch — relocate to mirror or upstream repository 🔀
  • markrelease — create a tag for a given package revision and version 🏷️
  • upload — add a file to binrepo ⬆️
  • del — remove a file from binrepo 🗑️
  • up — update the working copy and synchronize all binaries ⤴️
  • obsolete — move a package in obsolete directory 💀

🌺 REPOSITORY LAYOUT 🌺

A detailed description can be found at:

http://wiki.mandriva.com/en/Development/Packaging/RepositorySystem

The svn repository used by mgarepo consists of a set of branches in the top directory, followed by package directories having the internal package structure. 🌈

The internal package layout contains a directory current/, which contains the latest version of the package (equivalent to "trunk" in software repositories). The directory releases/ contain copies of older submitted packages that have been already released, it is organized in the <version>/<release> format (equivalent to "tags" directories). 🎀

URLs used in mgarepo commands refer to the package directory, and never to current. In other words, the http://host/svn/cauldron/foo is valid, whereas http://host/svn/cauldron/foo/current is not. 🚫

One example layout:

 /packages/cauldron
     |
     +- cauldron/
     |  ...
     |  +- rsync/
     |  +- coreutils/
     |  +- make/
     |  +- foo/
     |     +- current/
     |     |  +- SOURCES/
     |     |  +- SPECS/
     |     +- releases/
     |        ...
     |        +- 1.0
     |           +- 1.mga1/
     |              +- SOURCES/
     |              +- SPECS/
     |           +- 2.mga1/
     |           ...
     +- updates/
        +- 1/
        +- 2/
        +- 3/

🌸 Setting up a repository 🌸

The minimal setup is accomplished with a Subversion repository having three directories: cauldron/, misc/ and updates/. The name of this directories can be changed using the configuration options trunk-dir and branches-dir. Having this you can start importing packages with mgarepo import. 💖

💖 CONFIGURATION 💖

🌸 Introduction 🌸

okay bestie, so the main character config file is /etc/mgarepo.conf, and it's in .ini format. basically it's a whole set of [name] sections, and inside each one you've got variables written as name = value.

and if it exists, the file ~/.mgarepo/config gets loaded too. double config, double slay. ✨

👑 [global] section 👑

  • repository = URL — holds the base URL that gets used to reach packages in the svn repository whenever you only type a package name in your mgarepo commands. like, if you run mgarepo co trafshow and repository is set to http://host/svn/, then the URL http://host/svn/cauldron/trafshow is what gets used (cauldron is the default branch, iykyk).
  • default_parent = URL — points at the base URL of the development branch of the svn repository. > heads up: this one is deprecated, it got replaced by repository.
  • mirror = URL — the URL of an alternative, read-only repository used when checking out packages. and mgarepo ci will automatically relocate over to repository when you commit. cute, right?
  • use-mirror = yes/no — turns off using the mirror repository when checking out packages.
  • url-map = MATCH-REGEXP REPLACE-EXPR — this one's for the server side, and it remaps remote URLs that users bring when running mgarepo submit into local (and probably faster) URLs. MATCH-REGEXP is a Python regular expression matching the components that have to be reused in the local URL. REPLACE-EXPR is a replace expression that should expand into the final URL. example: svn+ssh://svn.mageia.org/(.*) file:///1
  • tempdir = PATH — the directory used as the base for temporary directories and files that mgarepo creates.
  • download-command = COMMAND-FMT — the command used to download generic remote URLs. it accepts the variables $url and $dest. rn it's used when you run mgarepo sync -d.
  • svn-command = COMMAND — the base command used to execute svn(1). it runs through system(3).
  • svn-env = VAR=VALUE .. — the environment variables to use when running svn. you can define more entries by using more lines. the variable defined by default is SVN_SSH, which points to the mgarepo-ssh ssh wrapper. 🫶
  • verbose = yes/no — cranks up the verbosity of mgarepo output, printing the commands being run and a complete traceback whenever an unhandled error happens.
  • trunk-dir — points to the default branch of the distro, used in commands that don't have their branch or URL specified.
  • branches-dir — the directory inside the repository that holds all the branches of the distro. it's used to build the URL of packages referred to with the branch notation BRANCH/PACKAGE, like in mgarepo co 1/mutt.

🎀 [submit-groups] section 🎀

this section holds aliases for groups of packages you want to submit all at once. so like, a line saying my-python-packages = bzr bzrtools bzr-gtk would let you just run mgarepo submit my-python-packages. iconic.

and yes, distro branches or revision numbers can be specified for each package group too. example: mgarepo submit 1/my-python-packages. ✨

💅 [submit] section 💅

  • host = HOST — sets the default host where mgarepo submit will run the submit helper.
  • default = TARGET — the default target used in mgarepo submit when the -t option isn't used.

🌈 [submit TARGET] sections (server-side only) 🌈

these sections describe each one of the sections available for submitting packages. their configuration options are:

  • target = PATH — the path where SRPMs generated by create-srpm- will be placed during the submit process.
  • allowed = URLs — a space-delimited list of package URLs that are allowed to be used with this target. the comparison works by checking whether the package URL used in submit starts with one of the URLs in this option.
  • scripts = PATHS — a space-delimited list of scripts that get run, each receiving the generated SRPM as its first argument. these scripts are usually used to make small changes to the SRPM structure, like bumping the release number for example.
  • rpm-macros = NAMES — points to sections in the config that will contain the RPM macros used when generating the SRPM of the package being submitted. those sections should be named in the [macros NAME] format.

🦋 [macros NAME] sections (server-side only) 🦋

these sections contain variables that get defined as RPM macros when generating the SRPM of the package being submitted. it's usually used to define the distribution suffix that goes in package releases, like "mga1".

💜 [users] section (server-side only) 💜

this section maps the usernames found in svn to their real names and e-mails. it's used when generating the changelog based on commits in svn, and by authoremail. example: joe = Joe User <joeuser@host.com>.

you can use this section on the client side too, but ngl it will have no effect on the changelogs generated on the server side.

⭐ [helper] section ⭐

  • create-srpm = PATH — the path of the script that gets run through ssh on the submit host when you run mgarepo submit.
  • upload-srpm = PATH — (server-side only) the path of the script that gets called after the generated SRPM is copied to its target location (see the target sections above) and the target scripts are run.
  • rpmbuild = COMMAND — the command used to call rpmbuild. note that build options (like -bs) are supplied by mgarepo itself.

🌸 [log] section 🌸

  • oldurl = URL — the URL of a directory structure that will contain old changelogs of packages, which get appended to the changelog being generated by rpmlog or getsrpm -l.
  • merge-spec = yes/no — if enabled, changelogs generated by mgarepo will have the contents of the %changelog found in the .spec file of the package appended to them.
  • sort = yes/no — if enabled, the changelog gets resorted after it's generated. super useful when the changelogs found in oldurl or in the .spec's %changelog section are newer than the ones generated by SVN.
  • revision-offset = REVISION-NUMBER — the base revision used to generate changelogs. as in svn log -r REVISION-OFFSET:HEAD URL.
  • ignore-string = STRING — the mark used to hide log messages. when it appears at the beginning of the log message, the whole changeset log gets hidden. when it's found in the middle of a string, only that line won't be shown.
  • unignore-string = STRING — the complement of the previous option. when this token is found, only those lines containing this mark will be shown. it's meant to be used on very long log messages.

🎀 [template] section 🎀

  • path = PATH — Obsolete. the path of the template used to generate the changelog from svn commits.
  • name = NAME — the name of the template used to generate the changelog from svn commits. use default or revno.

🍓 [srpm] section 🍓

  • run-prep = yes/no — Repsys can check for the presence of a file named Makefile in the top directory of the package and run make prep-srpm so that it can generate the actual files that must be distributed in the srpm. this option enables that feature. (Note: the command is expected to run in a restricted environment, so the Makefile must use only minimal functionalities.)

✨ ENVIRONMENT VARIABLES ✨

  • REPSYS_CONF — sets the configuration file to be read by mgarepo.

💖 FILES 💖

  • ~/.mgarepo/config
  • /etc/mgarepo.conf
  • /usr/share/mgarepo/
  • /usr/share/doc/mgarepo/

💀 BUGS 💀

go check the list of bugs at http://bugs.mageia.org/buglist.cgi?quicksearch=mgarepo — pls do report stuff bestie, it helps everyone. 🙈

👀 SEE ALSO 👀

👑 AUTHOR 👑

repsys was originally written by Gustavo Niemeyer <gustavo@niemeyer.net> for the Conectiva Linux distribution. after that it was maintained by Mandriva contributors and employees. mgarepo is a fork of repsys maintained by Mageia contributors. the way that lineage is giving legacy, fr fr. 💜

and that's a wrap, bestie! this one's from the Mageia crew, dated 2011 Jan 11, and it's page mgarepo(8) — go forth and submit packages, you absolute main character. 🦋✨

📦 where this page comes from