/packit

Upstream project ← → Downstream distribution

Primary LanguagePythonMIT LicenseMIT

Packit

This project provides tooling and automation to integrate upstream open source projects into Fedora operating system.

What and why?

  • Our intent is to bring downstream and upstream communities closer: provide feedback from downstream to upstream. (e.g. "Hello <upstream project Y>, your newest release doesn't work in Fedora rawhide, it breaks <Z>, here is a link to logs.")

  • We want to only merge, build and compose components which integrate well with the rest of the operating system. The biggest impact of such behavior will be on Fedora rawhide and when working on a new release.

  • Automatically pull and validate new upstream releases. This can be a trivial thing to do, why should maintainers waste their times on work which can be automated.

  • Developing in dist-git is cumbersome. Editing patch files and moving tarballs around is not fun. Why not working with the source code itself? With source git, you'll have an upstream repository and the dist-git content stuffed in a dedicated directory.

  • Let's use modern development techniques such as pull requests, code review, modern git forges, automation and continuous integration. We have computers to do all the mundane tasks. Why we, as humans, should do such work?

  • We want dist-git to be "a database of content in a release" rather a place to do actual work. On the other hand, you'll still be able to interact with dist-git the same way. We are not taking that away. Source git is meant to be the modern, better alternative.

DevConf.cz "Auto-maintain your package" talk.

Ehm, what's source-git?

Content of source-git repository is equivalent to dist-git, but uses upstream format: source files instead of tarballs, git commits instead of patches.

You can host this repository, or the specific git branch, anywhere you want. If you open a pull request, you will receive feedback on the changes:

  • Does the package build with the changes?
  • Do all the package tests pass?
  • How about tests of the dependant packages?
  • Are the changes good to be included in Fedora?

The goal of packit is to provide automation and tooling to interact with source-git repositories so you don't have to touch dist-git ever again. Our plan is to center development experience around upstream repositories and source-git.

Upstream repositories and source-git repositories are pretty much the same thing. Creating source-git only makes sense when the upstream does not accept downstream spec file or adding spec file to such a project doesn't make sense.

For more info on source-git, please read the detailed design doc.

Plan

  • Automatically release to Fedora Rawhide (by the end of February 2019).

    • Once there is a new upstream release, create a PR in downstream pagure.

  • Send new downstream changes back to upstream. (so the spec files are in sync)

  • Provide feedback on upstream pull requests.

    • Run RPM builds in COPR and integrate the results into Github.

Current status

Work has begun on the MVP.

Usage

The software is far from being even an alpha quality. Most of the values and configuration is hard-coded inside the scripts. Once we prove this project, we'll start working on configuration and user experience. You've been warned.

There is a makefile in this repository which can be used to build the container images and run them locally with podman.

Before that, you should create a file secrets.yaml and store your github and pagure API tokens in there. This file is then used during deployment as a source for ansible variables which are utilized by the containers:

$ cat ./secrets.yaml
github_token: 123456

# This token is needed to access data in pagure.
# This is meant to be an API token of your user
# https://src.fedoraproject.org/settings#nav-api-tab
pagure_user_token: 456789

# We need this token to be able to comment on a pagure pull request.
# If you don't have commit access to the package, you should ask maintainer of
# the package to generate a token for the specific dist-git repository.
# https://src.fedoraproject.org/rpms/<package>/settings#apikeys-tab
pagure_package_token: ABCDEF

# This token is needed to create a pull request
# https://src.fedoraproject.org/fork/<user>/rpms/<package>/settings#apikeys-tab
pagure_fork_token: QWERTY

The next thing you need, in order for the tooling to be able to push to your fork in Fedora dist-git, SSH keys.

Please place two files to the root of this repo:

  • bigger-secret — public key
  • biggest-secret — private key

Both of them are in .gitignore so they will not land in git.

Let's build and run now:

$ make build
$ make run-local

Candidates for early adoption

Please, open a PR if you want to be on the list, or just let us know.

  • Identity team (@pvoborni)
  • Plumbers & shells (@msekletar @lnykryn @siteshwar)
  • pykickstart (@dcantrell @larskarlitski)
  • python-operator-courier (Ralph Bean)
  • @thrix
  • youtube-dl (Till Mass)
  • anaconda (@jkonecny12)

Resources