Skip to content

Commit 9efe425

Browse files
committed
Move out job specific retriggering docs and link them
We want to have one authoritative page that will have the up to date info so that we don't need to update info on multiple places in case of changes.
1 parent 897ac65 commit 9efe425

9 files changed

Lines changed: 87 additions & 107 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 [retriggering docs](/docs/retriggering#bodhi_update).
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: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -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 [retriggering docs](/docs/retriggering#koji_build).
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/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/retriggering.md

Lines changed: 61 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ In general, you can put a `/packit <job-you-want-to-trigger>` comment
88
to trigger the Packit job manually.
99

1010
### copr_build
11-
So for [Copr builds](/docs/configuration/upstream/copr_build), Packit is able to trigger new builds based on a pull request comment:
11+
For retriggering the [`copr_build`](/docs/configuration/upstream/copr_build) jobs, Packit is able to trigger new builds based on a pull request comment:
1212

1313
/packit copr-build
1414

@@ -19,10 +19,6 @@ or the shorter version
1919
So whenever you run into a flake or feel like you want to retrigger, just type
2020
that comment into the PR and enjoy some fine, fresh builds.
2121

22-
It is also possible to re-trigger only the failed builds using a pull request comment
23-
24-
/packit rebuild-failed
25-
2622
The same can be used to retrigger jobs configured with either `commit` or `release`
2723
trigger by specifying the respective arguments, using commit comments:
2824

@@ -36,25 +32,22 @@ If no additional arguments are provided, Packit defaults to the commit trigger o
3632
default branch. The job will execute only if a corresponding job configuration exists for the
3733
specified branch or release and if the commit is included on the specified branch or tag.
3834

35+
It is also possible to re-trigger only the failed builds using a pull request comment
36+
37+
/packit rebuild-failed
38+
3939
### propose_downstream
40-
For [`propose_downstream`](/docs/configuration/upstream/propose_downstream), you need to place this comment to any issue:
40+
For retriggering the [`propose_downstream`](/docs/configuration/upstream/propose_downstream) jobs, users with write or admin permissions to
41+
the repository can retrigger an
42+
update via a comment in any open issue in the upstream repository:
4143

4244
/packit propose-downstream
4345

44-
4546
### tests
4647

4748
For retriggering the [`tests`](/docs/configuration/upstream/tests) jobs, you can use a pull-request comment:
4849

4950
/packit test
50-
51-
52-
And to re-trigger only the failed tests, you can use
53-
54-
/packit retest-failed
55-
56-
For testing, there is possible to specify also other arguments for more advanced use-cases, see
57-
the details [here](/docs/configuration/upstream/tests#running-tests-with-builds-from-another-pull-request).
5851

5952
The same can be used to retrigger jobs configured with either `commit` or `release`
6053
trigger by specifying the respective arguments, using commit comments:
@@ -65,10 +58,50 @@ or
6558

6659
/packit test --release <tag-name>
6760

61+
6862
If no additional arguments are provided, Packit defaults to the commit trigger on the repository's
6963
default branch. The job will execute only if a corresponding job configuration exists for the
7064
specified branch or release and if the commit is included on the specified branch or tag.
7165

66+
And to re-trigger only the failed tests in pull request, you can use
67+
68+
/packit retest-failed
69+
70+
#### Running tests with builds from another pull request
71+
It is also possible to run the tests with Copr builds built by Packit in another pull request
72+
(in a different repository). This can be useful when you are working on a change that spans
73+
multiple projects and needs to be tested together.
74+
These tests are possible to trigger only via a comment containing the argument specifying the pull request as:
75+
76+
/packit test <namespace>/<repo>#<pr_id>
77+
78+
The requirement is that in the specified PR, there were recent successful builds created by Packit
79+
for the targets configured in the repository with the "main" pull request.
80+
This is a new feature, so the behaviour may be adjusted in the future.
81+
Please reach out back to us for help or with your suggestions.
82+
83+
#### Running tests with a specific identifier
84+
It is possible to run a specific job via `/packit test` command.
85+
The user just needs to specify the argument `--identifier <job_identifier>` and Packit will trigger only the job with this identifier.
86+
The whole command should look like this: `/packit test --identifier my-job-id`.
87+
You can also configure [`test_command.default_identifier`](/docs/configuration#default_identifier) to allow commonly used jobs
88+
to be triggered without the need for manual specification.
89+
90+
#### Running a group of tests with the same label
91+
Users can trigger a specific group of jobs that has a specific value in the list of `labels` option.
92+
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.
93+
The labels should be in the format of comma-separated string.
94+
You can also configure [`test_command.default_labels`](/docs/configuration#default_labels) to allow commonly used job combinations
95+
to be triggered without the need for manual specification.
96+
97+
#### Running tests with specific environment variables
98+
From time to time, you may need to pass specific environment variables to your jobs.
99+
To achieve this, you can use the `--env` option in the comment command `/packit test`, which passes environment variables to Testing Farm.
100+
You can set as many environment variables as you want; you just need to pass `--env `for each one.
101+
For example, you can use the following command `/packit test --env MY_ENV=test --env MY_ENV_2=test_2`.
102+
This command allows you to use `MY_ENV` and `MY_ENV_2` in Testing Farm jobs.
103+
You can also unset an environment variable by not setting its value like `/packit test --env MY_ENV=`.
104+
72105
### upstream_koji_build
73106

74107
For retriggering the [`upstream_koji_build`](/docs/configuration/upstream/upstream_koji_build) jobs, you can
@@ -79,40 +112,34 @@ again use a pull-request comment:
79112
### vm_image_build
80113

81114
[VM Image builds](/docs/configuration/upstream/vm_image_build) are not triggered automatically at all.
82-
To trigger them, you need to post a pull-request comment:
115+
To trigger them, users with write access to the repository need to post a pull-request comment:
83116

84117
/packit vm-image-build
85118

86119
every time.
87120

88-
89-
:::caution
90-
91-
The requirements stated [above](#approval) apply, so if you see this message
92-
93-
Only users with write or admin permissions to the repository can trigger
94-
Packit-as-a-Service
95-
96-
it means the author of the comment does not have write access to the
97-
repository so the build cannot be scheduled. This is a perfect case for
98-
maintainers of the repository to post `/packit build` in the PR to get a build.
99-
100-
:::
101-
102121
### pull_from_upstream
103-
Packagers can retrigger the job
122+
For retriggering the [`pull_from_upstream`](/docs/configuration/downstream/pull_from_upstream) jobs, packagers can retrigger the job
104123
via a comment in any dist-git pull request:
105124

106125
/packit pull-from-upstream
107126

108127
This will take the Packit configuration file from the default branch of the dist-git
109-
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:
128+
repository (`rawhide`), same as if the job was triggered by a new release.
129+
You can monitor the job in [Packit Dashboard](https://dashboard.packit.dev/jobs/pull-from-upstreams).
130+
To use the configuration file from the dist-git pull request you are commenting on, you can add an argument:
110131

111132
/packit pull-from-upstream --with-pr-config
112133

134+
`pull-from-upstream` automatically handles the Bugzilla created by Upstream
135+
Release Monitoring (by default adds `Resolves` to changelog/commit and exposes `PACKIT_RESOLVED_BUGS` to the `changelog-entry` and `commit-message`
136+
actions). If you want to override the referenced resolved bug set by Packit, you can retrigger `pull_from_upstream` like this:
137+
138+
/packit pull-from-upstream --resolve-bug rhbz#123,rhbz#124
139+
113140
### koji_build
114141

115-
Packagers can retrigger a build by a comment in a dist-git pull request:
142+
For retriggering the [`koji_build`](/docs/configuration/downstream/koji_build) jobs, packagers can retrigger a build by a comment in a dist-git pull request:
116143

117144
/packit koji-build
118145

@@ -123,7 +150,7 @@ If Packit created an issue in the configured `issue_repository`, you can place t
123150
issue to retrigger the builds (see [`issue_repository`](/docs/configuration#issue_repository) for details).
124151

125152
### bodhi_update
126-
Packagers with write access to the dist-git repository can retrigger an update by a comment in a dist-git pull request:
153+
For retriggering the [`bodhi_update`](/docs/configuration/downstream/bodhi_update) jobs, packagers with write access to the dist-git repository can retrigger an update by a comment in a dist-git pull request:
127154

128155
/packit create-update
129156

0 commit comments

Comments
 (0)