Skip to content

Commit

Permalink
Add explanation on how Packit closes bugzillas (#806)
Browse files Browse the repository at this point in the history
  • Loading branch information
majamassarini authored Jan 12, 2024
2 parents 021502d + 316335c commit fb635a4
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 3 deletions.
13 changes: 11 additions & 2 deletions docs/configuration/downstream/pull_from_upstream.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,17 @@ A dist-git only job that opens a new dist-git pull request in
src.fedoraproject.org when a new upstream release happens using a notification
from [release-monitoring.org](https://release-monitoring.org/). Upstream Release Monitoring creates a Bugzilla
for the new upstream release and this Bugzilla is by default referenced in the dist-git changelog as
`- Resolves rhbz#xz` and `- Resolves rhbz#xz` in the commit message. This behaviour can be customized
using [actions](/docs/configuration/actions#syncing-the-release).
`- Resolves rhbz#xz` and `- Resolves rhbz#xz` in the commit message.


Bodhi updates created by the `bodhi_update` job as well as [automatic Bodhi updates](https://fedora-infra.github.io/bodhi/6.0/user/automatic_updates.html) will have this Bugzilla assigned and it will be closed when they reach stable.
There is also an env variable with the list of bugs to be closed
`PACKIT_RESOLVED_BUGS` that you can use in the case you want to customize the changelog creation but still have
the bugs automatically closed.

This job behaviour can be customized
using [actions](/docs/configuration/actions#syncing-the-release). The `PACKIT_RESOLVED_BUGS` env variable is
available both for the `commit-message` and `changelog-entry` actions.

This job utilizes the same logic as [`propose_downstream`](/docs/configuration/upstream/propose_downstream) with the only
exception that it is defined and executed in dist-git.
Expand Down
11 changes: 10 additions & 1 deletion docs/fedora-releases-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -221,7 +221,16 @@ functionality. This means that Packit doesn't need to be set up in the
upstream project: everything is configured in Fedora dist-git. So when a new
upstream release happens and
[release-monitoring.org](https://release-monitoring.org/) detects it, you'll
get dist-git pull requests with it automatically. If you want to restrict what releases with corresponding tags Packit should react on,
get dist-git pull requests with it automatically.

Bodhi updates created by the [`bodhi_update` job](/docs/configuration/downstream/pull_from_upstream) as well as [automatic Bodhi updates](https://fedora-infra.github.io/bodhi/6.0/user/automatic_updates.html) will close the Bugzilla opened by
the Upstream Release Monitoring automatically when they reach stable.
Packit adds the Bugzillas numbers to the commit message and the changelog in this form `- Resolves rhbz#xz`.
There is also an env variable with the list of bugs to be closed
`PACKIT_RESOLVED_BUGS` that you can use in the case you want to customize the changelog creation through an action
as shown below.

If you want to restrict what releases with corresponding tags Packit should react on,
you can utilise the configuration options [`upstream_tag_include`](/docs/configuration/#upstream_tag_include) and
[`upstream_tag_exclude`](/docs/configuration/#upstream_tag_exclude).

Expand Down

0 comments on commit fb635a4

Please sign in to comment.