Skip to content

Commit

Permalink
Clarify issue_repository config option (#779)
Browse files Browse the repository at this point in the history
Clarify issue_repository config option

Fixes #771

Reviewed-by: Nikola Forró
Reviewed-by: Laura Barcziová
  • Loading branch information
softwarefactory-project-zuul[bot] authored Nov 28, 2023
2 parents bd8ef21 + 14dd1e8 commit d923e29
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 7 deletions.
3 changes: 2 additions & 1 deletion docs/configuration/downstream/bodhi_update.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,9 @@ or any improvement we can implement.
to not need to change the config file when the new system version is released.

## Example

```yaml
issue_repository: https://github.com/my-username/packit-notifications

jobs:
- job: bodhi_update
trigger: commit
Expand Down
2 changes: 2 additions & 0 deletions docs/configuration/downstream/koji_build.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,8 @@ For Koji builds from upstream, see [`upstream_koji_build`](/docs/configuration/u
### Example

```yaml
issue_repository: https://github.com/my-username/packit-notifications

jobs:
- job: koji_build
trigger: commit
Expand Down
2 changes: 2 additions & 0 deletions docs/configuration/downstream/pull_from_upstream.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ When setting up this job for the first time, please follow the recommended actio
:::caution
Please, use the [`issue_repository`](/docs/configuration#issue_repository) option to get information about
possible failures during the update process (otherwise, you will not be notified about the job failures).
Use a repository you maintain as we will create issues about failures here.
:::caution


Expand Down Expand Up @@ -83,6 +84,7 @@ You can also append `&component={your-package-name}` to the query above to const

```yaml
upstream_project_url: https://github.com/packit/packit
issue_repository: https://github.com/my-username/packit-notifications

jobs:
- job: pull_from_upstream
Expand Down
8 changes: 2 additions & 6 deletions docs/configuration/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -448,14 +448,10 @@ this message is used as an extension of the comment added by default by Packit.
#### issue_repository

Use this key to be notified about errors of the downstream jobs (Koji build, Bodhi update, pull from upstream).
The value can be a URL of any GitHub/GitLab/Pagure project including dist-git
where issues are enabled and Packit has an identity on that git forger instance.
The value can be a URL of any GitHub/GitLab/Pagure project where issues are enabled and Packit has an identity on that git forge instance.
Alternatively, you can set up a dedicated project for receiving such notifications.
(Let us know if you need another instance to be supported.)
It does not need to be an upstream repository,
you can also enable an issue tracker for the dist-git repository
and use this as a place for those notifications.
Or, you can set up a dedicated project for receiving such notifications.
It does not need to be an upstream repository (and in case you do not maintain it, it also **should not** be).

By default, no issue will be created so Packit doesn't unintentionally spam any repository.
(E.g. Since those jobs are defined in downstream, upstream project does not need to be aware of Packit.)
Expand Down

0 comments on commit d923e29

Please sign in to comment.