Skip to content

Commit 6b84b86

Browse files
committed
Create separate page for retriggering docs
Fixes #1027
1 parent 5e8ca8d commit 6b84b86

5 files changed

Lines changed: 148 additions & 143 deletions

File tree

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/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+
```

docs/guide.md

Lines changed: 2 additions & 108 deletions
Original file line numberDiff line numberDiff line change
@@ -453,118 +453,12 @@ An example of Packit's checks in a pull request:
453453
![Packit pull request](img/guide/guide_pr_status.png)
454454

455455
## Retriggering
456-
### Comments for upstream jobs
457-
458-
In general, you can put a `/packit <job-you-want-to-trigger>` comment
459-
to trigger the Packit job manually.
460-
461-
#### copr_build
462-
So for [Copr builds](/docs/configuration/upstream/copr_build), Packit is able to trigger new builds based on a pull request comment:
463-
464-
/packit copr-build
465-
466-
or the shorter version
467-
468-
/packit build
469-
470-
So whenever you run into a flake or feel like you want to retrigger, just type
471-
that comment into the PR and enjoy some fine, fresh builds.
472-
473-
It is also possible to re-trigger only the failed builds using a pull request comment
474-
475-
/packit rebuild-failed
476-
477-
The same can be used to retrigger jobs configured with either `commit` or `release`
478-
trigger by specifying the respective arguments, using commit comments:
479-
480-
/packit build --commit <branch-name>
481-
482-
or
483-
484-
/packit build --release <tag-name>
485-
486-
If no additional arguments are provided, Packit defaults to the commit trigger on the repository's
487-
default branch. The job will execute only if a corresponding job configuration exists for the
488-
specified branch or release and if the commit is included on the specified branch or tag.
489-
490-
#### propose_downstream
491-
For [`propose_downstream`](/docs/configuration/upstream/propose_downstream), you need to place this comment to any issue:
492-
493-
/packit propose-downstream
494-
495-
496-
#### tests
497-
498-
For retriggering the [`tests`](/docs/configuration/upstream/tests) jobs, you can use a pull-request comment:
499-
500-
/packit test
501-
502-
503-
And to re-trigger only the failed tests, you can use
504-
505-
/packit retest-failed
506-
507-
For testing, there is possible to specify also other arguments for more advanced use-cases, see
508-
the details [here](/docs/configuration/upstream/tests#running-tests-with-builds-from-another-pull-request).
509-
510-
The same can be used to retrigger jobs configured with either `commit` or `release`
511-
trigger by specifying the respective arguments, using commit comments:
512-
513-
/packit test --commit <branch-name>
514-
515-
or
516-
517-
/packit test --release <tag-name>
518-
519-
If no additional arguments are provided, Packit defaults to the commit trigger on the repository's
520-
default branch. The job will execute only if a corresponding job configuration exists for the
521-
specified branch or release and if the commit is included on the specified branch or tag.
522-
523-
#### upstream_koji_build
524-
525-
For retriggering the [`upstream_koji_build`](/docs/configuration/upstream/upstream_koji_build) jobs, you can
526-
again use a pull-request comment:
527-
528-
/packit upstream-koji-build
529-
530-
#### vm_image_build
531-
532-
[VM Image builds](/docs/configuration/upstream/vm_image_build) are not triggered automatically at all.
533-
To trigger them, you need to post a pull-request comment:
534-
535-
/packit vm-image-build
536-
537-
every time.
538-
539-
540-
:::caution
541-
542-
The requirements stated [above](#approval) apply, so if you see this message
543-
544-
Only users with write or admin permissions to the repository can trigger
545-
Packit-as-a-Service
546-
547-
it means the author of the comment does not have write access to the
548-
repository so the build cannot be scheduled. This is a perfect case for
549-
maintainers of the repository to post `/packit build` in the PR to get a build.
550-
551-
:::
552-
553-
### GitHub Checks UI
554-
In GitHub Checks interface, it is also possible to re-trigger a specific task just by clicking on `Re-run`
555-
for the particular check:
556-
557-
![Re-run GitHub check](img/github/github-check-rerun.png)
558-
559-
The button is available only for users with write permissions to the repository.
560-
561-
### Comments for downstream jobs
562-
See [Retriggering](./fedora-releases-guide/dist-git-onboarding#retriggering) in Dist-git repository onboarding.
456+
You can find all the information on retriggering [here](./retriggering.md).
563457

564458

565459
And that's about it. Now you should be able to use the core features of the Packit.
566460
If you have any questions, feel free to [reach out to us](/#contact).
567461

568462

569463
We welcome all kinds of suggestions to this guide, feel free to [open a new issue
570-
here](https://github.com/packit/packit.dev/issues/new).
464+
here](https://github.com/packit/packit.dev/issues/new).

docs/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ sidebar_position: 0
88
* [Onboarding Guide](docs/guide) - How to start using Packit.
99
* [Fedora release guide](docs/fedora-releases-guide) - How to automate Fedora releases with Packit.
1010
* [Configuration for Packit](docs/configuration) - Configuration file description.
11+
* [Retriggering](docs/retriggering) - How to retrigger Packit jobs.
1112
* [Packit CLI](docs/cli) - Commands description.
1213
* [Actions](docs/configuration/actions) - Further customize Packit's behaviour.
1314
* [Generated code in upstream archives](docs/archive-not-matching-git) - When your release tarballs contain generated code and you need to patch it downstream.

docs/retriggering.md

Lines changed: 142 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,142 @@
1+
---
2+
title: Retriggering
3+
sidebar_position: 7
4+
---
5+
6+
## Comments
7+
In general, you can put a `/packit <job-you-want-to-trigger>` comment
8+
to trigger the Packit job manually.
9+
10+
### 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:
12+
13+
/packit copr-build
14+
15+
or the shorter version
16+
17+
/packit build
18+
19+
So whenever you run into a flake or feel like you want to retrigger, just type
20+
that comment into the PR and enjoy some fine, fresh builds.
21+
22+
It is also possible to re-trigger only the failed builds using a pull request comment
23+
24+
/packit rebuild-failed
25+
26+
The same can be used to retrigger jobs configured with either `commit` or `release`
27+
trigger by specifying the respective arguments, using commit comments:
28+
29+
/packit build --commit <branch-name>
30+
31+
or
32+
33+
/packit build --release <tag-name>
34+
35+
If no additional arguments are provided, Packit defaults to the commit trigger on the repository's
36+
default branch. The job will execute only if a corresponding job configuration exists for the
37+
specified branch or release and if the commit is included on the specified branch or tag.
38+
39+
### propose_downstream
40+
For [`propose_downstream`](/docs/configuration/upstream/propose_downstream), you need to place this comment to any issue:
41+
42+
/packit propose-downstream
43+
44+
45+
### tests
46+
47+
For retriggering the [`tests`](/docs/configuration/upstream/tests) jobs, you can use a pull-request comment:
48+
49+
/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).
58+
59+
The same can be used to retrigger jobs configured with either `commit` or `release`
60+
trigger by specifying the respective arguments, using commit comments:
61+
62+
/packit test --commit <branch-name>
63+
64+
or
65+
66+
/packit test --release <tag-name>
67+
68+
If no additional arguments are provided, Packit defaults to the commit trigger on the repository's
69+
default branch. The job will execute only if a corresponding job configuration exists for the
70+
specified branch or release and if the commit is included on the specified branch or tag.
71+
72+
### upstream_koji_build
73+
74+
For retriggering the [`upstream_koji_build`](/docs/configuration/upstream/upstream_koji_build) jobs, you can
75+
again use a pull-request comment:
76+
77+
/packit upstream-koji-build
78+
79+
### vm_image_build
80+
81+
[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:
83+
84+
/packit vm-image-build
85+
86+
every time.
87+
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+
102+
### pull_from_upstream
103+
Packagers can retrigger the job
104+
via a comment in any dist-git pull request:
105+
106+
/packit pull-from-upstream
107+
108+
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:
110+
111+
/packit pull-from-upstream --with-pr-config
112+
113+
### koji_build
114+
115+
Packagers can retrigger a build by a comment in a dist-git pull request:
116+
117+
/packit koji-build
118+
119+
The build will be triggered for the target branch of the pull request using the most recent commit on the target branch
120+
(NOT the HEAD commit of the pull request).
121+
122+
If Packit created an issue in the configured `issue_repository`, you can place the same comment in that
123+
issue to retrigger the builds (see [`issue_repository`](/docs/configuration#issue_repository) for details).
124+
125+
### 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:
127+
128+
/packit create-update
129+
130+
The update will be triggered for the target branch of the pull request.
131+
132+
If Packit created an issue in the configured `issue_repository`, you can place the same comment in that
133+
issue to retrigger the updates (see [`issue_repository`](/docs/configuration#issue_repository) for details).
134+
135+
136+
## GitHub Checks UI
137+
In GitHub Checks interface, it is also possible to re-trigger a specific task just by clicking on `Re-run`
138+
for the particular check:
139+
140+
![Re-run GitHub check](img/github/github-check-rerun.png)
141+
142+
The button is available only for users with write permissions to the repository.

0 commit comments

Comments
 (0)