Skip to content

Commit b5a29b3

Browse files
Retriggering refactor (#1031)
Retriggering refactor Fixes #1027 Reviewed-by: Matej Focko
2 parents 5e8ca8d + 9efe425 commit b5a29b3

16 files changed

Lines changed: 205 additions & 220 deletions

File tree

docs/configuration/downstream/bodhi_update.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,6 @@ You can also utilise
1919
[Fedora Notifications](https://apps.fedoraproject.org/notifications/about)
2020
to tweak the notifications settings.
2121

22-
For retriggering the job, see [our release guide](/docs/fedora-releases-guide/dist-git-onboarding#retriggering).
23-
2422
:::tip Downstream configuration template
2523

2624
You can use our [downstream configuration template](/docs/configuration/downstream_configuration_template)
@@ -66,7 +64,10 @@ Packit dist-git configuration.
6664
a `koji_build` job with the same sidetag group configured in package `foo` in this update,
6765
you need to list `foo` here.
6866

69-
67+
## Retriggering
68+
69+
For retriggering the job, see [retriggering docs](/docs/retriggering#bodhi_update).
70+
7071
## Example
7172
```yaml
7273
issue_repository: https://github.com/my-username/packit-notifications

docs/configuration/downstream/koji_build.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ specified in the `allowed_pr_authors`.
2626

2727
Due to a [bug](https://github.com/packit/packit-service/issues/2537), if you merge a PR containing more than one
2828
commit or push more than one commit directly, the job may not be triggered even though all conditions are met.
29-
In such case please [trigger it manually](/docs/fedora-releases-guide/dist-git-onboarding#retriggering).
29+
In such case please [trigger it manually](/docs/retriggering#koji_build).
3030

3131
:::
3232

@@ -37,8 +37,6 @@ The koji build behaves as it was created manually, and you can utilise
3737
to be informed about the builds. Also, you can configure a repository where should we
3838
open issues in case of errors during the job via [`issue_repository`](/docs/configuration#issue_repository) configuration key.
3939

40-
For retriggering the job, see [our release guide](/docs/fedora-releases-guide/dist-git-onboarding#retriggering).
41-
4240
For Koji builds from upstream, see [`upstream_koji_build`](/docs/configuration/upstream/upstream_koji_build).
4341

4442
:::tip Downstream configuration template
@@ -113,6 +111,9 @@ Packit dist-git configuration.
113111
* **require.label** - you can specify labels that have to be present/absent on a pull request
114112
in order to trigger the build when it is merged. See configuration details [here](/docs/configuration#require).
115113

114+
## Retriggering
115+
116+
For retriggering the job, see [retriggering docs](/docs/retriggering#koji_build).
116117

117118
## Processing of dist-git events from Pagure
118119

@@ -176,6 +177,7 @@ Because of the potential issues with rendering:
176177
- continous lines represent _yes_
177178
:::
178179

180+
179181
### Example
180182

181183
```yaml

docs/configuration/downstream/pull_from_upstream.md

Lines changed: 1 addition & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -92,24 +92,8 @@ For more details and customization options, also check
9292
:::
9393

9494
## Retriggering
95-
Packagers can retrigger the job
96-
via a comment in any dist-git pull request:
9795

98-
/packit pull-from-upstream
99-
100-
This will take the Packit configuration file from the default branch of the dist-git
101-
repository (`rawhide`), same as if the job was triggered by a new release.
102-
You can monitor the job in [Packit Dashboard](https://dashboard.packit.dev/jobs/pull-from-upstreams).
103-
To use the configuration file from the dist-git pull request you are commenting on, you can add an argument:
104-
105-
/packit pull-from-upstream --with-pr-config
106-
107-
108-
`pull-from-upstream` automatically handles the Bugzilla created by Upstream
109-
Release Monitoring (by default adds `Resolves` to changelog/commit and exposes `PACKIT_RESOLVED_BUGS` to the `changelog-entry` and `commit-message`
110-
actions). If you want to override the referenced resolved bug set by Packit, you can retrigger `pull_from_upstream` like this:
111-
112-
/packit pull-from-upstream --resolve-bug rhbz#123,rhbz#124
96+
For retriggering the job, see [retriggering docs](/docs/retriggering#pull_from_upstream).
11397

11498
## Example
11599

docs/configuration/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Configuration
3-
sidebar_position: 7
3+
sidebar_position: 6
44
---
55

66
# Configuration

docs/configuration/upstream/copr_build.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,10 @@ that can change the behaviour of your Copr builds:
8686
* [**release_suffix**](https://packit.dev/docs/configuration#release_suffix)
8787
* [**srpm_build_deps**](https://packit.dev/docs/configuration#srpm_build_deps)
8888

89+
## Retriggering
90+
91+
For retriggering the job, see [retriggering docs](/docs/retriggering#copr_build).
92+
8993
## Using a custom Copr project
9094
When using a custom Copr project (by specifying `project` and `owner`) you need to:
9195
- allow Packit to build in your custom Copr project,

docs/configuration/upstream/propose_downstream.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -81,10 +81,8 @@ jobs:
8181
This config would update Fedora Rawhide and Fedora 39 dist-git branches.
8282

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

87-
/packit propose-downstream
85+
For retriggering the job, see [retriggering docs](/docs/retriggering#propose_downstream).
8886

8987

9088
## Syncing the release to CentOS Stream

docs/configuration/upstream/tests.md

Lines changed: 4 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -200,54 +200,10 @@ And there are also pairs of variables for pull-request jobs:
200200

201201
Note that some variables do not need to be set if the value is unknown, irrelevant or not-configured.
202202

203-
## Restart Testing
204-
205-
The testing will automatically start after an update to the pull request
206-
(and successful Copr build if `skip_build` is false).
207-
To trigger retesting manually (can come handy in case of infrastructure
208-
issues for example), you can use the following comment in the pull request:
209-
210-
/packit test
211-
212-
Or if you want to re-trigger only failed tests, you can use the following comment
213-
in the pull request:
214-
215-
/packit retest-failed
216-
217-
## Running tests with builds from another pull request
218-
It is also possible to run the tests with Copr builds built by Packit in another pull request
219-
(in a different repository). This can be useful when you are working on a change that spans
220-
multiple projects and needs to be tested together.
221-
These tests are possible to trigger only via a comment containing the argument specifying the pull request as:
222-
223-
/packit test <namespace>/<repo>#<pr_id>
224-
225-
The requirement is that in the specified PR, there were recent successful builds created by Packit
226-
for the targets configured in the repository with the "main" pull request.
227-
This is a new feature, so the behaviour may be adjusted in the future.
228-
Please reach out back to us for help or with your suggestions.
229-
230-
## Running tests with a specific identifier
231-
It is possible to run a specific job via `/packit test` command.
232-
The user just needs to specify the argument `--identifier <job_identifier>` and Packit will trigger only the job with this identifier.
233-
The whole command should look like this: `/packit test --identifier my-job-id`.
234-
You can also configure [`test_command.default_identifier`](/docs/configuration#default_identifier) to allow commonly used jobs
235-
to be triggered without the need for manual specification.
236-
237-
## Running a group of tests with the same label
238-
Users can trigger a specific group of jobs that has a specific value in the list of `labels` option.
239-
The command to pick up these jobs is `/packit test --labels regression,upgrade` where either `regression` or `upgrade` must be present in `labels` option for the job.
240-
The labels should be in the format of comma-separated string.
241-
You can also configure [`test_command.default_labels`](/docs/configuration#default_labels) to allow commonly used job combinations
242-
to be triggered without the need for manual specification.
243-
244-
## Running tests with specific environment variables
245-
From time to time, you may need to pass specific environment variables to your jobs.
246-
To achieve this, you can use the `--env` option in the comment command `/packit test`, which passes environment variables to Testing Farm.
247-
You can set as many environment variables as you want; you just need to pass `--env `for each one.
248-
For example, you can use the following command `/packit test --env MY_ENV=test --env MY_ENV_2=test_2`.
249-
This command allows you to use `MY_ENV` and `MY_ENV_2` in Testing Farm jobs.
250-
You can also unset an environment variable by not setting its value like `/packit test --env MY_ENV=`.
203+
## Retriggering
204+
205+
For retriggering the job, see [retriggering docs](/docs/retriggering#tests).
206+
251207

252208
## Test job statuses
253209
By default, while test jobs are waiting for their corresponding build jobs to finish,

docs/configuration/upstream/upstream_koji_build.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,3 +40,7 @@ the more explicit `upstream_koji_build`.)
4040
* **branch** - the name of the branch we want to build for when using **commit** trigger
4141
(defaults to the repository's default branch) or target branch when using **pull_request** trigger
4242
(default behaviour is reacting to all pull requests in the repository).
43+
44+
## Retriggering
45+
46+
For retriggering the job, see [retriggering docs](/docs/retriggering#upstream_koji_build).

docs/configuration/upstream/vm_image_build.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,10 @@ Image builds are only triggered after a collaborator places a comment `/packit
3030
vm-image-build` in a pull request. The image builds are **NOT** submitted
3131
automatically. This is a subject to change as we improve the integration in future.
3232

33+
## Retriggering
34+
35+
For retriggering the job, see [retriggering docs](/docs/retriggering#vm_image_build).
36+
3337

3438
## Example
3539

docs/fedora-releases-guide/dist-git-onboarding.md

Lines changed: 2 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -236,39 +236,7 @@ open issues in case of errors during the downstream jobs via [`issue_repository`
236236
configuration key. See the details in the link.
237237

238238
## Retriggering
239-
### pull_from_upstream
240-
Packagers can retrigger the job
241-
via a comment in any dist-git pull request:
242-
243-
/packit pull-from-upstream
244-
245-
This will take the Packit configuration file from the default branch of the dist-git
246-
repository (`rawhide`), same as if the job was triggered by a new release. To use the configuration file from the dist-git pull request you are commenting on, you can add an argument:
247-
248-
/packit pull-from-upstream --with-pr-config
249-
250-
### koji_build
251-
252-
Packagers can retrigger a build by a comment in a dist-git pull request:
253-
254-
/packit koji-build
255-
256-
The build will be triggered for the target branch of the pull request using the most recent commit on the target branch
257-
(NOT the HEAD commit of the pull request).
258-
259-
If Packit created an issue in the configured `issue_repository`, you can place the same comment in that
260-
issue to retrigger the builds (see [`issue_repository`](/docs/configuration#issue_repository) for details).
261-
262-
### bodhi_update
263-
Packagers with write access to the dist-git repository can retrigger an update by a comment in a dist-git pull request:
264-
265-
/packit create-update
266-
267-
The update will be triggered for the target branch of the pull request.
268-
269-
If Packit created an issue in the configured `issue_repository`, you can place the same comment in that
270-
issue to retrigger the updates (see [`issue_repository`](/docs/configuration#issue_repository) for details).
271-
239+
You can find all the information on retriggering [here](../retriggering.md).
272240

273241
## Full example of a dist-git only configuration
274242

@@ -293,4 +261,4 @@ jobs:
293261
trigger: commit
294262
dist_git_branches:
295263
- fedora-branched # rawhide updates are created automatically
296-
```
264+
```

0 commit comments

Comments
 (0)