Skip to content

Commit

Permalink
Restructure Fedora release guide
Browse files Browse the repository at this point in the history
Create a dedicated subsection for dist-git repository onboarding.
Include also new information suggested in packit#802

Fixes packit#802
  • Loading branch information
lbarcziova committed Feb 27, 2024
1 parent 349436d commit 4840ea0
Show file tree
Hide file tree
Showing 7 changed files with 511 additions and 461 deletions.
2 changes: 1 addition & 1 deletion docs/configuration/downstream/bodhi_update.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ like a manually created Bodhi update, and you can utilise
[Fedora Notifications](https://apps.fedoraproject.org/notifications/about)
to tweak the notifications settings.

For retriggering the job, see [our release guide](/docs/fedora-releases-guide).
For retriggering the job, see [our release guide](/docs/fedora-releases-guide/dist-git-onboarding#retriggering).

:::tip Downstream configuration template

Expand Down
2 changes: 1 addition & 1 deletion docs/configuration/downstream/koji_build.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ The koji build behaves as it was created manually, and you can utilise
to be informed about the builds. Also, you can configure a repository where should we
open issues in case of errors during the job via [`issue_repository`](/docs/configuration#issue_repository) configuration key.

For retriggering the job, see [our release guide](/docs/fedora-releases-guide).
For retriggering the job, see [our release guide](/docs/fedora-releases-guide/dist-git-onboarding#retriggering).

For Koji builds from upstream, see [`upstream_koji_build`](/docs/configuration/upstream/upstream_koji_build).

Expand Down
4 changes: 2 additions & 2 deletions docs/configuration/downstream/pull_from_upstream.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Packit dist-git configuration.

## First setup
When setting up this job for the first time, please follow the recommended actions from
[our release guide](/docs/fedora-releases-guide#first-setup).
[our release guide](/docs/fedora-releases-guide/dist-git-onboarding#first-setup).

:::caution
Please, use the [`issue_repository`](/docs/configuration#issue_repository) option to get information about
Expand All @@ -72,7 +72,7 @@ Use a repository you maintain as we will create issues about failures here.
:::tip

For more details and customization options, also check
[our release guide](/docs/fedora-releases-guide#pull-from-upstream-job).
[our release guide](/docs/fedora-releases-guide/dist-git-onboarding#pull-from-upstream-job).

:::

Expand Down
32 changes: 32 additions & 0 deletions docs/configuration/upstream/propose_downstream.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,33 @@ sidebar_position: 5
Land a new upstream release in Fedora (or CentOS Stream). This job only makes sure the changes
happen in dist-git - no builds. A pull request is created as a result.

Packit gets the information about the newly created release (not a git tag) from GitHub/GitLab,
loads the config from the release commit and if there is a `propose_downstream` job
defined, the workflow begins.

For enabling the propose downstream job, you need to have
[Packit Service installed](/docs/guide/#1-set-up-packit-integration)
and have a `propose_downstream` job in the configuration file for the given upstream repository
(this job is also run by default if there is no `jobs` section
in the configuration, see [jobs configuration](/docs/configuration/#packit-service-jobs)).
The [propose_downstream job](/docs/configuration/upstream/propose_downstream) should be then configured like this:

```yaml
jobs:
- job: propose_downstream
trigger: release
dist_git_branches:
- main
```
You can adjust the `dist_git_branches` field to include the
dist-git branches you want to update and also utilise [aliases](/docs/configuration/#aliases)
instead of using hardcoded versions.

During proposing a new update, you will get updates of the job status via commit statuses/checks
on the release commit. These will provide links to our dashboard where you can find all the information about
the job including the logs. You can also check all propose downstream runs in
[this view](https://dashboard.packit.dev/jobs/propose-downstreams).

:::tip CentOS Stream support

We newly support `propose-downstream` also for CentOS Stream. The workflow is the same as for Fedora, but there are few
Expand Down Expand Up @@ -44,6 +71,11 @@ jobs:

This config would update Fedora Rawhide and Fedora 39 dist-git branches.

## Retriggering
Users with write or admin permissions to the repository can retrigger an
update via a comment in any open issue in the upstream repository:

/packit propose-downstream


## Syncing the release to CentOS Stream
Expand Down
Loading

0 comments on commit 4840ea0

Please sign in to comment.