Add Onboarding a New Component for Testing and Merge Automation doc #52
Conversation
WalkthroughA new Markdown file documents the end-to-end onboarding workflow for bringing a public component repository into OpenShift CI for testing and merge automation. It covers granting robot privileges and installing GitHub Apps for non-organization repos, running the interactive Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
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: 5
📜 Review details
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
hyperfleet/test-release/onboarding-a-new-component-for-testing-and-merge-automation.md
🧰 Additional context used
🪛 LanguageTool
hyperfleet/test-release/onboarding-a-new-component-for-testing-and-merge-automation.md
[style] ~8-~8: Consider a more concise word here.
Context: ...rivileges and Installing the GitHub App In order to add labels, move PRs and issues into mi...
(IN_ORDER_TO_PREMIUM)
[style] ~9-~9: In American English, abbreviations like “etc.” require a period.
Context: ... and issues into milestones, merge PRs, etc, the robots will need write access to y...
(ETC_PERIOD)
[uncategorized] ~11-~11: The official name of this software platform is spelled with a capital “H”.
Context: ...nent repository is not in the OpenShift github organization: 1. Invite openshift-ci-ro...
(GITHUB)
[grammar] ~35-~35: Ensure spelling is correct
Context: .../$org/$repo directory ## Tips Add an exmaple for "make new-repo" interactive mode st...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🪛 markdownlint-cli2 (0.18.1)
hyperfleet/test-release/onboarding-a-new-component-for-testing-and-merge-automation.md
15-15: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
16-16: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
🔇 Additional comments (1)
hyperfleet/test-release/onboarding-a-new-component-for-testing-and-merge-automation.md (1)
100-100: Remove or add the missing image asset.The document references
images/image1.pngon line 100, but the file does not exist athyperfleet/test-release/images/image1.png. Either add the image file to the correct location or remove the markdown reference.
hyperfleet/test-release/onboarding-a-new-component-for-testing-and-merge-automation.md
Outdated
Show resolved
Hide resolved
hyperfleet/test-release/onboarding-a-new-component-for-testing-and-merge-automation.md
Outdated
Show resolved
Hide resolved
hyperfleet/test-release/onboarding-a-new-component-for-testing-and-merge-automation.md
Outdated
Show resolved
Hide resolved
hyperfleet/test-release/onboarding-a-new-component-for-testing-and-merge-automation.md
Outdated
Show resolved
Hide resolved
hyperfleet/test-release/onboarding-a-new-component-for-testing-and-merge-automation.md
Outdated
Show resolved
Hide resolved
yingzhanredhat
force-pushed
the
ying-test
branch
2 times, most recently
from
764190d to
488c9b8
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (3)
hyperfleet/test-release/onboarding-a-new-component-for-testing-and-merge-automation.md (3)
10-10: Add missing period after "etc."The abbreviation requires a comma and period when used mid-sentence.
🔎 Proposed fix
-In order to add labels, move PRs and issues into milestones, merge PRs, etc, the robots will need write access to your repository. +In order to add labels, move PRs and issues into milestones, merge PRs, etc., the robots will need write access to your repository.
12-12: Capitalize "GitHub" correctly.The official name uses a capital "H".
🔎 Proposed fix
-If your component repository is not in the OpenShift github organization: +If your component repository is not in the OpenShift GitHub organization:
16-17: Fix markdown list indentation.Nested list items should align properly. These lines use 2-space indentation but should be flush-left (0 spaces) to be siblings of the parent numbered item.
🔎 Proposed fix
3. The **openshift-merge-robot** must be given **admin** permissions to support either of the following use cases: - - In order for **tide** to automatically merge PRs it must be allowed to verify the repo's allowed merge methods. - - By default, it enables [branch-protection](https://docs.ci.openshift.org/docs/architecture/branch-protection/) for all prow-controlled repos. It can disable it in prow's [config.yaml](https://github.com/openshift/release/blob/master/core-services/prow/02_config/_config.yaml) +- In order for **tide** to automatically merge PRs it must be allowed to verify the repo's allowed merge methods. +- By default, it enables [branch-protection](https://docs.ci.openshift.org/docs/architecture/branch-protection/) for all prow-controlled repos. It can disable it in prow's [config.yaml](https://github.com/openshift/release/blob/master/core-services/prow/02_config/_config.yaml)
📜 Review details
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
hyperfleet/test-release/images/image1.pngis excluded by!**/*.png
📒 Files selected for processing (1)
hyperfleet/test-release/onboarding-a-new-component-for-testing-and-merge-automation.md
🧰 Additional context used
🪛 LanguageTool
hyperfleet/test-release/onboarding-a-new-component-for-testing-and-merge-automation.md
[style] ~9-~9: Consider a more concise word here.
Context: ...rivileges and Installing the GitHub App In order to add labels, move PRs and issues into mi...
(IN_ORDER_TO_PREMIUM)
[style] ~10-~10: In American English, abbreviations like “etc.” require a period.
Context: ... and issues into milestones, merge PRs, etc, the robots will need write access to y...
(ETC_PERIOD)
[uncategorized] ~12-~12: The official name of this software platform is spelled with a capital “H”.
Context: ...nent repository is not in the OpenShift github organization: 1. Invite **openshift-ci-...
(GITHUB)
🪛 markdownlint-cli2 (0.18.1)
hyperfleet/test-release/onboarding-a-new-component-for-testing-and-merge-automation.md
4-4: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
16-16: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
17-17: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
hyperfleet/test-release/onboarding-a-new-component-for-testing-and-merge-automation.md
Show resolved
Hide resolved
| In order to add labels, move PRs and issues into milestones, merge PRs, etc, the robots will need write access to your repository. | ||
|
|
||
| If your component repository is not in the OpenShift github organization: | ||
| 1. Invite **openshift-ci-robot** and **openshift-merge-robot** into your organization or add them as [collaborators](https://docs.github.com/en/github/setting-up-and-managing-your-github-user-account/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository) for the repository. |
There was a problem hiding this comment.
In our repo, the robots are added to a special team names automation-bots, no need to invite them again. The access can be granted to the team automatically.
There was a problem hiding this comment.
will a note under this line for our current repository
There was a problem hiding this comment.
A note is not enough here. Since this doc only works to hyperfleet organization repos, you can use the note as the reality. And put the prow steps as a note for additional usage out of openshift-hyperfleet organization.
There was a problem hiding this comment.
Updated it. Add a Prow doc link instead of the detailed steps to make it simple since the steps are copied for the offical doc
hyperfleet/test-release/onboarding-a-new-component-for-testing-and-merge-automation.md
Outdated
Show resolved
Hide resolved
hyperfleet/test-release/onboarding-a-new-component-for-testing-and-merge-automation.md
Outdated
Show resolved
Hide resolved
hyperfleet/test-release/onboarding-a-new-component-for-testing-and-merge-automation.md
Show resolved
Hide resolved
yingzhanredhat
force-pushed
the
ying-test
branch
from
488c9b8 to
d440bef
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (2)
hyperfleet/test-release/onboarding-a-new-component-for-testing-and-merge-automation.md (2)
10-10: Fix punctuation and capitalization.Line 10: Add period after "etc" in American English. Line 12: Capitalize "GitHub" per official branding. These issues were flagged in previous reviews.
🔎 Proposed fixes
-In order to add labels, move PRs and issues into milestones, merge PRs, etc, the robots will need write access to your repository. +In order to add labels, move PRs and issues into milestones, merge PRs, etc., the robots will need write access to your repository.-If your component repository is not in the OpenShift github organization: +If your component repository is not in the OpenShift GitHub organization:Also applies to: 12-12
4-4: Use heading syntax instead of emphasis for document structure.Replace bold emphasis with proper heading markup to ensure the document renders with a correct outline.
🔎 Proposed fix
-**Metadata** +## Metadata
🧹 Nitpick comments (3)
hyperfleet/test-release/onboarding-a-new-component-for-testing-and-merge-automation.md (3)
33-33: Fix spelling error: "repositry" → "repository".🔎 Proposed fix
-After creating the **OWNERS** file in your new repository when preparing the new repositry via [repository-creation-guidelines.md](../docs/repository-creation-guidelines.md), copy it to the **/core-services/prow/02_config/$org/$repo** directory +After creating the **OWNERS** file in your new repository when preparing the new repository via [repository-creation-guidelines.md](../docs/repository-creation-guidelines.md), copy it to the **/core-services/prow/02_config/$org/$repo** directory
119-121: Fix spelling error and remove space in link text.Line 119: "exmaple" should be "example". Line 121: Remove space before closing bracket in link text per markdown standards.
🔎 Proposed fixes
-Here is the exmaple to enable the Prow configures (You can set it in one PR) +Here is the example to enable the Prow configures (You can set it in one PR)-[Set the lgtm_acts_as_approve to true ] +[Set the lgtm_acts_as_approve to true]
68-72: Improve phrasing and fix hyphenation in test description.Line 69: Use hyphen for compound modifier ("integration-style tests"). Line 70: Remove redundant "of" phrase ("inside" is sufficient).
🔎 Proposed fixes
Test scripts execute unit or integration style tests by running a command -from your repository inside of a test container. For example, +from your repository inside a test container. For example,Also apply hyphenation:
-execute unit or integration style tests by running a command +execute unit or integration-style tests by running a command
📜 Review details
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
hyperfleet/test-release/images/image1.pngis excluded by!**/*.png
📒 Files selected for processing (1)
hyperfleet/test-release/onboarding-a-new-component-for-testing-and-merge-automation.md
🧰 Additional context used
🪛 LanguageTool
hyperfleet/test-release/onboarding-a-new-component-for-testing-and-merge-automation.md
[style] ~9-~9: Consider a more concise word here.
Context: ...rivileges and Installing the GitHub App In order to add labels, move PRs and issues into mi...
(IN_ORDER_TO_PREMIUM)
[style] ~10-~10: In American English, abbreviations like “etc.” require a period.
Context: ... and issues into milestones, merge PRs, etc, the robots will need write access to y...
(ETC_PERIOD)
[uncategorized] ~12-~12: The official name of this software platform is spelled with a capital “H”.
Context: ...nent repository is not in the OpenShift github organization: 1. Invite **openshift-ci-...
(GITHUB)
[grammar] ~33-~33: Ensure spelling is correct
Context: ...r new repository when preparing the new repositry via [repository-creation-guidelines.md]...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~69-~69: Use a hyphen to join words.
Context: ...Test scripts execute unit or integration style tests by running a command from yo...
(QB_NEW_EN_HYPHEN)
[style] ~70-~70: This phrase is redundant. Consider using “inside”.
Context: ... running a command from your repository inside of a test container. For example, a unit t...
(OUTSIDE_OF)
[grammar] ~119-~119: Ensure spelling is correct
Context: ...ored for their own PR. ``` Here is the exmaple to enable the Prow configures (You can ...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🪛 markdownlint-cli2 (0.18.1)
hyperfleet/test-release/onboarding-a-new-component-for-testing-and-merge-automation.md
4-4: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
14-14: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
17-17: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
18-18: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
19-19: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
100-100: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
121-121: Spaces inside link text
(MD039, no-space-in-links)
hyperfleet/test-release/onboarding-a-new-component-for-testing-and-merge-automation.md
Outdated
Show resolved
Hide resolved
yingzhanredhat
force-pushed
the
ying-test
branch
from
d440bef to
f0974fe
Compare
There was a problem hiding this comment.
Actionable comments posted: 2
♻️ Duplicate comments (5)
hyperfleet/test-release/onboarding-a-new-component-for-testing-and-merge-automation.md (5)
4-4: [DUPLICATE] Use heading syntax instead of bold emphasis for section titles.Both "Metadata" (line 4) and "Note" (line 20) should use proper heading markup (e.g.,
##or###) for better document structure.🔎 Proposed fix
-**Metadata** +## Metadata-**Note** +## NoteAlso applies to: 20-20
10-10: [DUPLICATE] Add missing period after "etc."The abbreviation requires a period in American English.
🔎 Proposed fix
-In order to add labels, move PRs and issues into milestones, merge PRs, etc, the robots will need write access to your repository. +In order to add labels, move PRs and issues into milestones, merge PRs, etc., the robots will need write access to your repository.
12-12: [DUPLICATE] Capitalize "GitHub" correctly.The official name uses a capital "H".
🔎 Proposed fix
-If your component repository is not in the OpenShift github organization: +If your component repository is not in the OpenShift GitHub organization:
16-17: [DUPLICATE] Fix markdown list indentation for nested items.Nested bullets should align consistently. Lines 16-17 and 21 have incorrect indentation per markdown standards.
🔎 Proposed fix
3. The **openshift-merge-robot** must be given **admin** permissions to support either of the following use cases: - - In order for **tide** to automatically merge PRs it must be allowed to verify the repo's allowed merge methods. - - By default, it enables [branch-protection](https://docs.ci.openshift.org/docs/architecture/branch-protection/) for all prow-controlled repos. It can disable it in prow's [config.yaml](https://github.com/openshift/release/blob/master/core-services/prow/02_config/_config.yaml) - - For current repository under **openshift-hyperfleet** organization, it uses team **automation-bots** to grant the same permission for the two bots here. And it can be done according to the [repository-creation-guidelines.md](../docs/repository-creation-guidelines.md) when creating the new repository.So you can skip the above step. +- In order for **tide** to automatically merge PRs it must be allowed to verify the repo's allowed merge methods. +- By default, it enables [branch-protection](https://docs.ci.openshift.org/docs/architecture/branch-protection/) for all prow-controlled repos. It can disable it in prow's [config.yaml](https://github.com/openshift/release/blob/master/core-services/prow/02_config/_config.yaml) +- For current repository under **openshift-hyperfleet** organization, it uses team **automation-bots** to grant the same permission for the two bots here. And it can be done according to the [repository-creation-guidelines.md](../docs/repository-creation-guidelines.md) when creating the new repository.So you can skip the above step. **Note** - - For current repository under **openshift-hyperfleet** organization, it uses team **automation-bots** to grant the same permission for the two bots here. And it can be done according to the [repository-creation-guidelines.md](../docs/repository-creation-guidelines.md) when creating the new repository.So you can skip the above step. +- For current repository under **openshift-hyperfleet** organization, it uses team **automation-bots** to grant the same permission for the two bots here. And it can be done according to the [repository-creation-guidelines.md](../docs/repository-creation-guidelines.md) when creating the new repository. So you can skip the above step.Also applies to: 21-21
121-121: [DUPLICATE] Fix spelling error: "exmaple" → "example".🔎 Proposed fix
-Here is the exmaple to enable the Prow configures (You can set it in one PR) +Here is the example to enable the Prow configures (You can set it in one PR)
📜 Review details
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
hyperfleet/test-release/images/image1.pngis excluded by!**/*.png
📒 Files selected for processing (1)
hyperfleet/test-release/onboarding-a-new-component-for-testing-and-merge-automation.md
🧰 Additional context used
🪛 LanguageTool
hyperfleet/test-release/onboarding-a-new-component-for-testing-and-merge-automation.md
[style] ~9-~9: Consider a more concise word here.
Context: ...rivileges and Installing the GitHub App In order to add labels, move PRs and issues into mi...
(IN_ORDER_TO_PREMIUM)
[style] ~10-~10: In American English, abbreviations like “etc.” require a period.
Context: ... and issues into milestones, merge PRs, etc, the robots will need write access to y...
(ETC_PERIOD)
[uncategorized] ~12-~12: The official name of this software platform is spelled with a capital “H”.
Context: ...nent repository is not in the OpenShift github organization: 1. Invite **openshift-ci-...
(GITHUB)
[grammar] ~34-~34: Ensure spelling is correct
Context: ...r new repository when preparing the new repositry via [repository-creation-guidelines.md]...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~121-~121: Ensure spelling is correct
Context: ...ored for their own PR. ``` Here is the exmaple to enable the Prow configures (You can ...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🪛 markdownlint-cli2 (0.18.1)
hyperfleet/test-release/onboarding-a-new-component-for-testing-and-merge-automation.md
4-4: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
16-16: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
17-17: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
20-20: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
21-21: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
123-123: Spaces inside link text
(MD039, no-space-in-links)
hyperfleet/test-release/onboarding-a-new-component-for-testing-and-merge-automation.md
Outdated
Show resolved
Hide resolved
hyperfleet/test-release/onboarding-a-new-component-for-testing-and-merge-automation.md
Outdated
Show resolved
Hide resolved
yingzhanredhat
force-pushed
the
ying-test
branch
from
f0974fe to
fe449a0
Compare
There was a problem hiding this comment.
Actionable comments posted: 2
♻️ Duplicate comments (5)
hyperfleet/test-release/onboarding-a-new-component-for-testing-and-merge-automation.md (5)
4-4: Use proper heading syntax instead of bold text.Line 4 should use heading markup (
## Metadata) rather than bold emphasis (**Metadata**) for proper document structure and compliance with markdown standards.🔎 Proposed fix
-**Metadata** +## Metadata
12-12: Capitalize "GitHub" correctly.The official name of the platform uses a capital "G" and "H". Update "Github" to "GitHub".
🔎 Proposed fix
-If your component repository is not in the OpenShift Github organization: +If your component repository is not in the OpenShift GitHub organization:
16-17: Fix markdown list indentation for nested bullets.Nested bullet points under the numbered list item should align at the proper indentation level (4 spaces for nesting under a numbered item).
🔎 Proposed fix
3. The **openshift-merge-robot** must be given **admin** permissions to support either of the following use cases: - - In order for **tide** to automatically merge PRs it must be allowed to verify the repo's allowed merge methods. - - By default, it enables [branch-protection](https://docs.ci.openshift.org/docs/architecture/branch-protection/) for all prow-controlled repos. It can disable it in prow's [config.yaml](https://github.com/openshift/release/blob/master/core-services/prow/02_config/_config.yaml) + - In order for **tide** to automatically merge PRs it must be allowed to verify the repo's allowed merge methods. + - By default, it enables [branch-protection](https://docs.ci.openshift.org/docs/architecture/branch-protection/) for all prow-controlled repos. It can disable it in prow's [config.yaml](https://github.com/openshift/release/blob/master/core-services/prow/02_config/_config.yaml)
121-121: Fix spelling error: "exmaple" → "example".🔎 Proposed fix
-Here is the exmaple to enable the Prow configures (You can set it in one PR) +Here is the example to enable the Prow configures (You can set it in one PR)
123-123: Remove trailing space inside link text.🔎 Proposed fix
-[Set the lgtm_acts_as_approve to true ] +[Set the lgtm_acts_as_approve to true]
📜 Review details
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
hyperfleet/test-release/images/image1.pngis excluded by!**/*.png
📒 Files selected for processing (1)
hyperfleet/test-release/onboarding-a-new-component-for-testing-and-merge-automation.md
🧰 Additional context used
🪛 LanguageTool
hyperfleet/test-release/onboarding-a-new-component-for-testing-and-merge-automation.md
[style] ~9-~9: Consider a more concise word here.
Context: ...rivileges and Installing the GitHub App In order to add labels, move PRs and issues into mi...
(IN_ORDER_TO_PREMIUM)
[uncategorized] ~12-~12: The official name of this software platform is spelled with a capital “H”.
Context: ...nent repository is not in the OpenShift Github organization: 1. Invite **openshift-ci-...
(GITHUB)
[grammar] ~121-~121: Ensure spelling is correct
Context: ...ored for their own PR. ``` Here is the exmaple to enable the Prow configures (You can ...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🪛 markdownlint-cli2 (0.18.1)
hyperfleet/test-release/onboarding-a-new-component-for-testing-and-merge-automation.md
4-4: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
16-16: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
17-17: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
20-20: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
21-21: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
🔇 Additional comments (1)
hyperfleet/test-release/onboarding-a-new-component-for-testing-and-merge-automation.md (1)
115-118: Ensure consistent spacing and formatting in YAML comments.Lines 115 and 118 have inconsistent spacing before comments (double space vs. single space). Align formatting for consistency. Additionally, verify the YAML syntax is valid—previous reviews noted trailing periods that were invalid.
🔎 Proposed fix for consistency
approve: - commandHelpLink: https://go.k8s.io/bot-commands - lgtm_acts_as_approve: true # An approver's /lgtm is simultaneously interpreted as an /approve + lgtm_acts_as_approve: true # An approver's /lgtm is simultaneously interpreted as an /approve repos: - openshift-hyperfleet/hyperfleet-api - require_self_approval: true # Even if the author is a approver in OWNER, their /approve command is ignored for their own PR. + require_self_approval: true # Even if the author is a approver in OWNER, their /approve command is ignored for their own PR.
hyperfleet/test-release/onboarding-a-new-component-for-testing-and-merge-automation.md
Outdated
Show resolved
Hide resolved
hyperfleet/test-release/onboarding-a-new-component-for-testing-and-merge-automation.md
Outdated
Show resolved
Hide resolved
yingzhanredhat
force-pushed
the
ying-test
branch
2 times, most recently
from
dd6bd44 to
b214219
Compare
There was a problem hiding this comment.
Actionable comments posted: 3
♻️ Duplicate comments (2)
hyperfleet/test-release/onboarding-a-new-component-for-testing-and-merge-automation.md (2)
4-4: Use heading syntax for section headers.Line 4 uses bold emphasis (
**Metadata**) instead of proper Markdown heading syntax. This should be## Metadatafor consistent document structure.🔎 Proposed fix
-**Metadata** +## Metadata
14-15: Fix heading syntax, capitalization, and spelling errors in Note section.Multiple issues in the Note section:
- Line 14: Use
## Noteheading syntax instead of bold emphasis- Line 15: "Github" should be "GitHub" (proper capitalization)
- Line 15: "premission" should be "permission" (spelling error)
🔎 Proposed fix
-**Note** - - If your component repository is not in the OpenShift Github organization, you can refer to the guidance [Granting Robots Privileges and Installing the GitHub App](https://docs.ci.openshift.org/docs/how-tos/onboarding-a-new-component/#granting-robots-privileges-and-installing-the-github-app) to grant robots premission +## Note + +- If your component repository is not in the OpenShift GitHub organization, you can refer to the guidance [Granting Robots Privileges and Installing the GitHub App](https://docs.ci.openshift.org/docs/how-tos/onboarding-a-new-component/#granting-robots-privileges-and-installing-the-github-app) to grant robots permission
🧹 Nitpick comments (1)
hyperfleet/test-release/onboarding-a-new-component-for-testing-and-merge-automation.md (1)
37-38: Improve the summary heading wording.The summary text uses informal phrasing "Cmd "make new-repo"". Consider a more professional alternative like "The "make new-repo" command in interactive mode step by step".
🔎 Proposed improvement
-<summary> Cmd "make new-repo" interactive mode step by step</summary> +<summary>The "make new-repo" command in interactive mode step by step</summary>
📜 Review details
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
hyperfleet/test-release/images/image1.pngis excluded by!**/*.png
📒 Files selected for processing (1)
hyperfleet/test-release/onboarding-a-new-component-for-testing-and-merge-automation.md
🧰 Additional context used
🪛 LanguageTool
hyperfleet/test-release/onboarding-a-new-component-for-testing-and-merge-automation.md
[style] ~9-~9: Consider a more concise word here.
Context: ...g Zhang ## Granting Robots Privileges In order to add labels, move PRs and issues into mi...
(IN_ORDER_TO_PREMIUM)
[grammar] ~15-~15: Ensure spelling is correct
Context: ...talling-the-github-app) to grant robots premission ## Prow Configuration ### 1. Bootstrap the ...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~120-~120: Ensure spelling is correct
Context: ...ored for their own PR. ``` Here is the exmaple to enable the Prow configures (You can ...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🪛 markdownlint-cli2 (0.18.1)
hyperfleet/test-release/onboarding-a-new-component-for-testing-and-merge-automation.md
4-4: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
14-14: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
15-15: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
121-121: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
122-122: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
hyperfleet/test-release/onboarding-a-new-component-for-testing-and-merge-automation.md
Show resolved
Hide resolved
hyperfleet/test-release/onboarding-a-new-component-for-testing-and-merge-automation.md
Show resolved
Hide resolved
hyperfleet/test-release/onboarding-a-new-component-for-testing-and-merge-automation.md
Outdated
Show resolved
Hide resolved
yingzhanredhat
force-pushed
the
ying-test
branch
from
b214219 to
043e12d
Compare
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (5)
hyperfleet/test-release/onboarding-a-new-component-for-testing-and-merge-automation.md (5)
2-2: Fix capitalization of OpenShift.This issue was flagged in a previous review but remains unaddressed. "OpenShift" requires both uppercase letters.
🔎 Proposed fix
-This document provides an overview of the workflow for onboarding new public component repositories to the Openshift CI. +This document provides an overview of the workflow for onboarding new public component repositories to the OpenShift CI.
4-4: Use proper heading syntax instead of emphasis.The "Metadata" section should use heading markup (
## Metadata) rather than bold emphasis for consistent document structure. This was flagged in a previous review.🔎 Proposed fix
-**Metadata** +## Metadata
14-15: Fix heading syntax, indentation, capitalization, and spelling in Note section.Multiple issues in this section:
- Line 14: Use heading markup (
## Note) instead of bold emphasis- Line 15: List indentation is incorrect (leading space before dash)
- Line 15: "Github" should be "GitHub"
- Line 15: "premission" should be "permission"
- Line 15: Missing terminal period
🔎 Proposed fix
-**Note** - - If your component repository is not in the OpenShift Github organization, you can refer to the guidance [Granting Robots Privileges and Installing the GitHub App](https://docs.ci.openshift.org/docs/how-tos/onboarding-a-new-component/#granting-robots-privileges-and-installing-the-github-app) to grant robots premission +## Note + +- If your component repository is not in the OpenShift GitHub organization, you can refer to the guidance [Granting Robots Privileges and Installing the GitHub App](https://docs.ci.openshift.org/docs/how-tos/onboarding-a-new-component/#granting-robots-privileges-and-installing-the-github-app) to grant robots permission.
33-33: Add missing period at end of sentence.Line 33 is a complete sentence but lacks terminal punctuation.
🔎 Proposed fix
-After creating the **OWNERS** file in your new repository when preparing the new repository via [repository-creation-guidelines.md](../docs/repository-creation-guidelines.md), copy it to the **/core-services/prow/02_config/$org/$repo** directory +After creating the **OWNERS** file in your new repository when preparing the new repository via [repository-creation-guidelines.md](../docs/repository-creation-guidelines.md), copy it to the **/core-services/prow/02_config/$org/$repo** directory.
120-122: Fix grammar, list indentation, and phrasing in examples section.Multiple issues in this section:
- Line 120: Awkward phrasing "Here is the example to enable the Prow configures"; should be "Here are examples to enable Prow configuration:" or similar
- Lines 121-122: List items have incorrect indentation (1 space before dash instead of 0)
🔎 Proposed fix
-Here is the example to enable the Prow configures (You can set it in one PR) - - [Enable the prow configures](https://github.com/openshift/release/pull/72693/files) - - [Set the lgtm_acts_as_approve to true](https://github.com/openshift/release/pull/72902/files) +Here are examples to enable Prow configuration (you can set them in one PR): + +- [Enable the prow configures](https://github.com/openshift/release/pull/72693/files) +- [Set the lgtm_acts_as_approve to true](https://github.com/openshift/release/pull/72902/files)
🧹 Nitpick comments (1)
hyperfleet/test-release/onboarding-a-new-component-for-testing-and-merge-automation.md (1)
38-38: Improve wording of section summary.The summary text uses "Cmd" as an abbreviation, which is informal. Consider spelling it out for clarity.
🔎 Suggested improvement
-<summary> Cmd "make new-repo" interactive mode step by step</summary> +<summary>Command "make new-repo" interactive mode step by step</summary>
📜 Review details
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
hyperfleet/test-release/images/image1.pngis excluded by!**/*.png
📒 Files selected for processing (1)
hyperfleet/test-release/onboarding-a-new-component-for-testing-and-merge-automation.md
🧰 Additional context used
🪛 LanguageTool
hyperfleet/test-release/onboarding-a-new-component-for-testing-and-merge-automation.md
[style] ~9-~9: Consider a more concise word here.
Context: ...g Zhang ## Granting Robots Privileges In order to add labels, move PRs and issues into mi...
(IN_ORDER_TO_PREMIUM)
[grammar] ~15-~15: Ensure spelling is correct
Context: ...talling-the-github-app) to grant robots premission ## Prow Configuration ### 1. Bootstrap the ...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🪛 markdownlint-cli2 (0.18.1)
hyperfleet/test-release/onboarding-a-new-component-for-testing-and-merge-automation.md
4-4: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
14-14: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
15-15: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
121-121: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
122-122: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
🔇 Additional comments (1)
hyperfleet/test-release/onboarding-a-new-component-for-testing-and-merge-automation.md (1)
1-127: Consolidate and resolve outstanding issues from previous reviews.This document has accumulated several issues across previous review cycles that remain unaddressed in the current state (marked as "✅ Addressed" but still present). Recommended: systematically apply all pending fixes in a single commit to ensure consistent quality and avoid repeated review cycles.
hyperfleet/test-release/onboarding-a-new-component-for-testing-and-merge-automation.md
Outdated
Show resolved
Hide resolved
hyperfleet/test-release/onboarding-a-new-component-for-testing-and-merge-automation.md
Outdated
Show resolved
Hide resolved
yingzhanredhat
force-pushed
the
ying-test
branch
from
043e12d to
cc2a731
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (3)
hyperfleet/test-release/onboarding-a-new-component-for-testing-and-merge-automation.md (3)
2-4: Fix capitalization and use proper heading syntax.Line 2: "Openshift CI" should be "OpenShift CI" (capital S and H per official branding).
Line 4: "Metadata" is formatted as bold emphasis but should be a heading (
## Metadata) for proper document structure.🔎 Proposed fixes
-This document provides an overview of the workflow for onboarding new public component repositories to the Openshift CI. +This document provides an overview of the workflow for onboarding new public component repositories to the OpenShift CI. -**Metadata** +## Metadata
120-122: Fix grammar and list indentation in examples section.Line 120: Awkward phrasing; "Here is the example to enable the Prow configures" should be more concise and grammatically correct (e.g., "Here are examples of enabling Prow configurations").
Lines 121–122: List items are indented 1 space instead of 0; they should align at the left margin.
🔎 Proposed fix
-Here is the example to enable the Prow configures (You can set it in one PR) - - [Enable the prow configures](https://github.com/openshift/release/pull/72693/files) - - [Set the lgtm_acts_as_approve to true](https://github.com/openshift/release/pull/72902/files) +Here are examples of enabling Prow configurations (you can set them in one PR): + +- [Enable the prow configures](https://github.com/openshift/release/pull/72693/files) +- [Set the lgtm_acts_as_approve to true](https://github.com/openshift/release/pull/72902/files)
33-33: Add missing period at end of sentence.Line 33: The sentence ends without a period; add one after "directory".
🔎 Proposed fix
-After creating the **OWNERS** file in your new repository when preparing the new repository via [repository-creation-guidelines.md](../docs/repository-creation-guidelines.md), copy it to the **/core-services/prow/02_config/$org/$repo** directory +After creating the **OWNERS** file in your new repository when preparing the new repository via [repository-creation-guidelines.md](../docs/repository-creation-guidelines.md), copy it to the **/core-services/prow/02_config/$org/$repo** directory.
📜 Review details
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
hyperfleet/test-release/images/image1.pngis excluded by!**/*.png
📒 Files selected for processing (1)
hyperfleet/test-release/onboarding-a-new-component-for-testing-and-merge-automation.md
🧰 Additional context used
🪛 LanguageTool
hyperfleet/test-release/onboarding-a-new-component-for-testing-and-merge-automation.md
[style] ~9-~9: Consider a more concise word here.
Context: ...g Zhang ## Granting Robots Privileges In order to add labels, move PRs and issues into mi...
(IN_ORDER_TO_PREMIUM)
[style] ~12-~12: To make your writing flow more naturally, try moving the adverb ‘already’ closer to the verb ‘been’.
Context: ... permission for the two bots. And if it already has been done by referring to the [repository-cr...
(PERF_TENS_ADV_PLACEMENT)
[grammar] ~15-~15: Ensure spelling is correct
Context: ...talling-the-github-app) to grant robots premission ## Prow Configuration ### 1. Bootstrap the ...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🪛 markdownlint-cli2 (0.18.1)
hyperfleet/test-release/onboarding-a-new-component-for-testing-and-merge-automation.md
4-4: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
14-14: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
15-15: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
121-121: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
122-122: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
hyperfleet/test-release/onboarding-a-new-component-for-testing-and-merge-automation.md
Outdated
Show resolved
Hide resolved
yingzhanredhat
force-pushed
the
ying-test
branch
from
cc2a731 to
b325b4f
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (5)
hyperfleet/test-release/onboarding-a-new-component-for-testing-and-merge-automation.md (5)
4-4: Use proper heading syntax instead of bold emphasis.Section headers should use markdown heading syntax (
##) for consistent document structure, not bold emphasis.-**Metadata** +## Metadata
33-33: Add missing period at end of sentence.Line 33 ends with a path reference but lacks proper sentence-ending punctuation.
-After creating the **OWNERS** file in your new repository when preparing the new repository via [repository-creation-guidelines.md](../docs/repository-creation-guidelines.md), copy it to the **/core-services/prow/02_config/$org/$repo** directory +After creating the **OWNERS** file in your new repository when preparing the new repository via [repository-creation-guidelines.md](../docs/repository-creation-guidelines.md), copy it to the **/core-services/prow/02_config/$org/$repo** directory.
2-2: Fix capitalization of OpenShift."Openshift CI" should use the proper capitalization "OpenShift CI" (capital S).
-This document provides an overview of the workflow for onboarding new public component repositories to the Openshift CI. +This document provides an overview of the workflow for onboarding new public component repositories to the OpenShift CI.
14-15: Fix heading syntax, list indentation, and spelling errors.Multiple issues here:
- Line 14: "Note" should use heading syntax (
## Note) instead of bold emphasis- Line 15: The list dash has incorrect indentation (1 space instead of 0)
- Line 15: "Github" should be capitalized as "GitHub"
- Line 15: "premission" is misspelled; should be "permission"
-**Note** - - If your component repository is not in the **openshift-hyperfleet** Github organization, you can refer to the guidance [Granting Robots Privileges and Installing the GitHub App](https://docs.ci.openshift.org/docs/how-tos/onboarding-a-new-component/#granting-robots-privileges-and-installing-the-github-app) to grant robots premission +## Note + +- If your component repository is not in the **openshift-hyperfleet** GitHub organization, you can refer to the guidance [Granting Robots Privileges and Installing the GitHub App](https://docs.ci.openshift.org/docs/how-tos/onboarding-a-new-component/#granting-robots-privileges-and-installing-the-github-app) to grant robots permission
120-122: Improve phrasing and fix list indentation.Lines 121–122 have incorrect indentation (1 space instead of 0). Additionally, the phrasing on line 120 could be more natural.
-Here is the example to enable the Prow configures (You can set it in one PR) - - [Enable the prow configures](https://github.com/openshift/release/pull/72693/files) - - [Set the lgtm_acts_as_approve to true](https://github.com/openshift/release/pull/72902/files) +Here are examples to enable Prow configurations (you can set them in one PR): + +- [Enable the prow configures](https://github.com/openshift/release/pull/72693/files) +- [Set the lgtm_acts_as_approve to true](https://github.com/openshift/release/pull/72902/files)
📜 Review details
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
hyperfleet/test-release/images/image1.pngis excluded by!**/*.png
📒 Files selected for processing (1)
hyperfleet/test-release/onboarding-a-new-component-for-testing-and-merge-automation.md
🧰 Additional context used
🪛 LanguageTool
hyperfleet/test-release/onboarding-a-new-component-for-testing-and-merge-automation.md
[style] ~9-~9: Consider a more concise word here.
Context: ...g Zhang ## Granting Robots Privileges In order to add labels, move PRs and issues into mi...
(IN_ORDER_TO_PREMIUM)
[grammar] ~15-~15: Ensure spelling is correct
Context: ...talling-the-github-app) to grant robots premission ## Prow Configuration ### 1. Bootstrap the ...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🪛 markdownlint-cli2 (0.18.1)
hyperfleet/test-release/onboarding-a-new-component-for-testing-and-merge-automation.md
4-4: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
14-14: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
15-15: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
121-121: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
122-122: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
| ## Detailed steps | ||
|
|
||
| <details> | ||
| <summary> Cmd "make new-repo" interactive mode step by step</summary> |
There was a problem hiding this comment.
Remove extra space inside summary tag.
HTML tag attributes should not have extra spaces before the closing >.
-<summary> Cmd "make new-repo" interactive mode step by step</summary>
+<summary>Cmd "make new-repo" interactive mode step by step</summary>📝 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.
| <summary> Cmd "make new-repo" interactive mode step by step</summary> | |
| <summary>Cmd "make new-repo" interactive mode step by step</summary> |
🤖 Prompt for AI Agents
In
hyperfleet/test-release/onboarding-a-new-component-for-testing-and-merge-automation.md
around line 38, the <summary> tag contains an extra leading space inside the tag
content ("<summary> Cmd..."); remove that extra space so the content reads
"<summary>Cmd "... (i.e., eliminate the space immediately after the opening tag)
and ensure there are no unintended spaces before the closing ">" of any HTML tag
in the line.
2 participants
https://issues.redhat.com/browse/HYPERFLEET-389
Add Onboarding a New Component for Testing and Merge Automation doc
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.