Skip to content

Commit e4c3381

Browse files
Add separate page for Fedora CI docs (#1030)
Add separate page for Fedora CI docs Fixes #1028 Reviewed-by: Nikola Forró
2 parents b5a29b3 + 9980c4f commit e4c3381

File tree

7 files changed

+102
-1
lines changed

7 files changed

+102
-1
lines changed

docusaurus.config.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,7 @@ const developmentSections = [
8181

8282
const sections = [
8383
new Section("docs", "Documentation"),
84+
new Section("fedora-ci", "Fedora CI"),
8485
new Section("source-git", "Source-git"),
8586
new Section("development", "Development", undefined, developmentSections),
8687
];

fedora-ci/configuration.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: Configuration
3+
sidebar_position: 3
4+
---
5+
6+
During the development phase, maintainers can opt in by adding their dist-git repository to the configuration [here](https://github.com/packit/deployment/blob/2cd9e846a6ab1c320f6a6c589e4bcab6b3cfb762/secrets/packit/prod/packit-service.yaml.j2#L105)
7+
and submitting a [pull request](https://github.com/packit/deployment/pulls).
8+
9+
In later phases, CI will run by default on all packages. The exact details of test plan configuration are still
10+
being finalized, but the plan is to have a global default configuration that works well for most repositories.

fedora-ci/development.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
title: Development
3+
sidebar_position: 4
4+
---
5+
6+
## Links
7+
8+
- [Fedora change proposal](https://fedoraproject.org/wiki/Changes/PackitDistgitCI)
9+
- Original proposal of this change, including the time plan and detailed description.
10+
- [Tracking issue](https://github.com/packit/packit-service/issues/2692)
11+
- Plan of the tasks to be implemented.
12+
- [Discussions](https://github.com/packit/packit/discussions/2520)
13+
- For ideas or suggestions to discuss, feel free to add a discussion topic.
14+
- [Issue tracker](https://github.com/packit/packit-service/issues/new?template=fedora-ci.yml)
15+
- For filing bug, new features, etc.
16+
- [Source code](https://github.com/packit/packit-service)
17+
- Source code of the CI implementation. This will be moved to a separate repository.
18+
- [#packit:fedora.im](https://matrix.to/#/#packit:fedora.im?web-instance[element.io]=chat.fedoraproject.org)
19+
- Matrix channel for answering any questions.
20+
21+
## Current plan
22+
23+
- [x] Phase 1: Introduce scratch builds for Fedora dist-git PRs (opt-in).
24+
- [ ] Phase 2 (In progress): Implement installability checks (opt-in).
25+
- [ ] Phase 3: Implement support for user-defined TMT tests (opt-in).
26+
- [ ] Final Phase: Transition to the new Packit-based CI as the default mechanism, replacing Fedora CI.

fedora-ci/index.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
title: Fedora CI documentation
3+
sidebar_position: 0
4+
id: index
5+
---
6+
7+
Packit as Fedora dist-git CI is implemented as part of [this Fedora change proposal](https://fedoraproject.org/wiki/Changes/PackitDistgitCI).
8+
The implementation is currently in progress.
9+
This initiative aims to transition Fedora dist-git CI to a Packit-based solution, deprecating Fedora CI and Fedora Zuul Tenant.
10+
The change affects the triggering and reporting mechanism for tests but does not alter the tests themselves or the test
11+
execution service ([Testing Farm](https://docs.testing-farm.io/Testing%20Farm/0.1/index.html)). The transition will be gradual, allowing maintainers to try the integration out,
12+
provide feedback and catch issues early.
13+
14+
For more info continue with:
15+
16+
- [Jobs run in CI](fedora-ci/jobs.md)
17+
- [Retriggering](fedora-ci/retriggering.md)
18+
- [Configuration](fedora-ci/configuration.md)
19+
- [Development](fedora-ci/development.md)

fedora-ci/jobs.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
title: Jobs run in CI
3+
sidebar_position: 1
4+
---
5+
6+
## Scratch builds
7+
8+
Scratch builds in [Koji](https://koji.fedoraproject.org/koji/) built from SCM.
9+
10+
## Tests
11+
12+
### Installability
13+
14+
TBD (The work is in progress.)
15+
16+
### Custom test plans
17+
18+
TBD (The work is planned.)

fedora-ci/retriggering.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: Retriggering
3+
sidebar_position: 2
4+
---
5+
6+
You can retrigger CI jobs in dist-git pull requests by posting comments that include the appropriate `/packit-ci` commands, as outlined below.
7+
8+
## Scratch builds
9+
10+
To retrigger a scratch build, add the following comment to the pull request:
11+
12+
```
13+
/packit-ci scratch-build
14+
```
15+
16+
Only packagers can retrigger scratch builds.

src/components/HomepageFeatures/index.tsx

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,11 +49,22 @@ const FeatureList: FeatureItem[] = [
4949
</>
5050
),
5151
},
52+
{
53+
title: "Running as Fedora dist-git CI",
54+
description: (
55+
<>
56+
After successfuly validating upstream projects, Packit is now becoming a
57+
CI solution also for{" "}
58+
<Link to="https://src.fedoraproject.org/">Fedora dist-git</Link>.{" "}
59+
<Link to="/fedora-ci">Learn more.</Link>
60+
</>
61+
),
62+
},
5263
];
5364

5465
function Feature({ title, description }: FeatureItem) {
5566
return (
56-
<div className={clsx("col col--4")}>
67+
<div className={clsx("col col--3")}>
5768
<div className="text--center padding-horiz--md">
5869
<h3>{title}</h3>
5970
<p>{description}</p>

0 commit comments

Comments
 (0)