From Fedora Project Wiki
(approved by the Modularity WG)
No edit summary
Line 49: Line 49:
==== What to do ====
==== What to do ====


Currently, adding a module is done by submitting a PR to the [https://pagure.io/pungi-fedora/ pagure.io/pungi-fedora] repository to include your module in the compose. This is defined in the [https://pagure.io/pungi-fedora/blob/f28/f/variants-fedora.xml variants-fedora.xml] file. Search for the "<modules>" element.
Add your module builds to an update in [https://bodhi.fedoraproject.org/ Bodhi]. Use the builds field as Bodhi doesn't yet support searching for modules by name.


In the near future, the process will change to be a bit more pleasant experience. New modules will be added as updates through Bodhi.
Please note that it might take about a day for your module to show up in updates-testing.


=== '''Step 4''': set / change the default ===
=== '''Step 4''': set / change the default ===

Revision as of 09:08, 28 March 2018

The process

The process has four main steps:

new repositories --> build it --> add it to the release --> set / change the default

Step 1: new repositories

This step includes creating new repositories or branches in dist-git for both RPM packages and modules.

Overview

Packages should be handled the same way as they are now. That means:

  • When adding a new package (creating a new dist-git repository), the package goes through the Package Review Process. This is to check the compliance with the Fedora Packaging Guidelines.
  • When adding a new branch to an existing package, no formal review is necessary.

Repositories and branches for modules should not require any review. This is because:

  • At this point, modules are not included in any release.
  • Modules themselves do not provide any content. New content is provided by packages that need to pass a review.

Of course, to request any repositories in the dist-git, one needs to be a Fedora packager.

What to do

Packages: Follow the Package Review Process for Contributors.

Modules: TBD (either filing a ticket somewhere, or using the fedrepo-req tool)

Step 2: build it

Overview

This step is about submitting a module build to the Fedora infrastructure. The resulting binaries will not be included in any release in this step. Anyone who is a Fedora packager should be able to build modules they own. There is no review or approval at this point.

What to do

Use the fedpkg module-build command inside your local copy of the module dist-git repository.

Step 3: add it to the release

Overview

In order to make a module available to the end user, it needs to be released. Technically, this means including the module in a compose.

No review is done at this point, as all the software that is being added already passed the Package Review Process.

What to do

Add your module builds to an update in Bodhi. Use the builds field as Bodhi doesn't yet support searching for modules by name.

Please note that it might take about a day for your module to show up in updates-testing.

Step 4: set / change the default

Overview

Setting or changing a default stream or a default installation profile of a module is in most cases similar to changing a major version of a package. Setting or changing the default stream or the default installation profile requires a Fedora Change request, and it is only allowed in between Fedora releases.

What to do

Submit an issue to Fedora Releng in pagure.io/releng. You also need to submit a Fedora Change

To check the current defaults, have a look at the fedora module defaults repository.