add doc for trigger prow job manually#62
Conversation
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: bmeng The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
openshift-ci
Bot
added
the
approved
Summary by CodeRabbit
WalkthroughAdded a new documentation page describing how to manually trigger OpenShift CI jobs via the Gangway API. The guide covers prerequisites, authentication steps using ChangesCI Triggering Documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/trigger-prow-ci-manually.md`:
- Around line 46-51: The fenced code block containing the curl POST example that
starts with ``` should include a language tag to satisfy markdownlint MD040;
change the opening fence from ``` to ```bash (the block that contains the curl
-X POST ... Authorization: Bearer $(oc whoami -t) ... /v1/executions) so the
snippet is correctly highlighted and linted.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Enterprise
Run ID: 5fc24eff-7c24-4258-834b-365173079347
📒 Files selected for processing (1)
docs/trigger-prow-ci-manually.md
| ``` | ||
| curl -X POST \ | ||
| -H "Authorization: Bearer $(oc whoami -t)" \ | ||
| -d '{"job_name": "periodic-ci-openshift-online-rosa-e2e-main-periodics-rosa-hcp-e2e-stable-4-21", "job_execution_type": "1"}' \ | ||
| https://gangway-ci.apps.ci.l2s4.p1.openshiftapps.com/v1/executions | ||
| ``` |
There was a problem hiding this comment.
Add a language tag to the example fenced block.
Line 46 opens a fenced code block without a language, which triggers markdownlint MD040.
Suggested fix
-```
+```bash
curl -X POST \
-H "Authorization: Bearer $(oc whoami -t)" \
-d '{"job_name": "periodic-ci-openshift-online-rosa-e2e-main-periodics-rosa-hcp-e2e-stable-4-21", "job_execution_type": "1"}' \
https://gangway-ci.apps.ci.l2s4.p1.openshiftapps.com/v1/executions</details>
<!-- suggestion_start -->
<details>
<summary>📝 Committable suggestion</summary>
> ‼️ **IMPORTANT**
> Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
```suggestion
🧰 Tools
🪛 markdownlint-cli2 (0.22.1)
[warning] 46-46: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/trigger-prow-ci-manually.md` around lines 46 - 51, The fenced code block
containing the curl POST example that starts with ``` should include a language
tag to satisfy markdownlint MD040; change the opening fence from ``` to ```bash
(the block that contains the curl -X POST ... Authorization: Bearer $(oc whoami
-t) ... /v1/executions) so the snippet is correctly highlighted and linted.
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/trigger-prow-ci-manually.md`:
- Line 51: The documented CI job name pattern is incorrect/inconsistent with the
example; update the text that currently states
"periodic-ci-openshift-release-main-nightly-<version>-<job>" to either present a
more general pattern or list multiple real patterns (e.g., include variants like
"periodic-ci-openshift-online-...-periodics-..." shown in the example). Edit the
sentence in docs/trigger-prow-ci-manually.md to replace the single hardcoded
pattern with a generalized description or a short list of known patterns and add
a note pointing readers to the openshift/release job definitions for exact job
names.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Enterprise
Run ID: 37ea1271-177f-4cb2-9bd3-1515327683c0
📒 Files selected for processing (1)
docs/trigger-prow-ci-manually.md
|
|
||
| ### Available Job Names | ||
|
|
||
| The CI job names follow the pattern `periodic-ci-openshift-release-main-nightly-<version>-<job>`. To find the exact job name, check the job definitions in the [openshift/release](https://github.com/openshift/release) repository or the CI dashboard. |
There was a problem hiding this comment.
The job name pattern doesn't match the example provided.
The described pattern periodic-ci-openshift-release-main-nightly-<version>-<job> doesn't match the example periodic-ci-openshift-online-rosa-e2e-main-periodics-rosa-hcp-e2e-stable-4-21. Key differences include the organization segment (openshift-release vs openshift-online) and the type segment (nightly vs periodics).
Consider updating the pattern description to be more general or clarify that multiple patterns exist for different job types.
📝 Suggested revision
-The CI job names follow the pattern `periodic-ci-openshift-release-main-nightly-<version>-<job>`. To find the exact job name, check the job definitions in the [openshift/release](https://github.com/openshift/release) repository or the CI dashboard.
+The CI job names typically follow the pattern `periodic-ci-<org>-<repo>-<branch>-<job-type>-<job-details>`. For example, nightly jobs use `periodic-ci-openshift-release-main-nightly-<version>-<job>`, while periodic jobs may use different patterns. To find the exact job name, check the job definitions in the [openshift/release](https://github.com/openshift/release) repository or the CI dashboard.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| The CI job names follow the pattern `periodic-ci-openshift-release-main-nightly-<version>-<job>`. To find the exact job name, check the job definitions in the [openshift/release](https://github.com/openshift/release) repository or the CI dashboard. | |
| The CI job names typically follow the pattern `periodic-ci-<org>-<repo>-<branch>-<job-type>-<job-details>`. For example, nightly jobs use `periodic-ci-openshift-release-main-nightly-<version>-<job>`, while periodic jobs may use different patterns. To find the exact job name, check the job definitions in the [openshift/release](https://github.com/openshift/release) repository or the CI dashboard. |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/trigger-prow-ci-manually.md` at line 51, The documented CI job name
pattern is incorrect/inconsistent with the example; update the text that
currently states "periodic-ci-openshift-release-main-nightly-<version>-<job>" to
either present a more general pattern or list multiple real patterns (e.g.,
include variants like "periodic-ci-openshift-online-...-periodics-..." shown in
the example). Edit the sentence in docs/trigger-prow-ci-manually.md to replace
the single hardcoded pattern with a generalized description or a short list of
known patterns and add a note pointing readers to the openshift/release job
definitions for exact job names.
|
@bmeng: The following test failed, say
Full PR test history. Your PR dashboard. DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here. |
2 participants
Description
Type of Change
Testing
make test)Checklist