search

PingCAP-QE / ci

Continue intergration tests
Apache License 2.0
19 stars 97 forks source link

docs PDF: add release-8.2 and remove archived versions #3020

Closed qiancai closed 4 days ago

qiancai commented 4 days ago

PR Type

configuration changes

Description

Changes walkthrough 📝

Relevant files
Configuration changes
docs-cn-postsubmits.yaml
Update branch patterns for docs-cn postsubmits                     
prow-jobs/pingcap/docs/docs-cn-postsubmits.yaml
  • Updated branch patterns for postsubmits.
  • Added support for release-8.2.
  • Removed support for release-5.0 and release-6.6.
    		•  +4/-4     
    docs-postsubmits.yaml
    Update branch patterns for docs postsubmits                           
    prow-jobs/pingcap/docs/docs-postsubmits.yaml
  • Updated branch patterns for postsubmits.
  • Added support for release-8.2.
  • Removed support for release-5.0 and release-6.6.
    		•  +4/-4     

    💡 PR-Agent usage: Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

    ti-chi-bot[bot] commented 4 days ago

    I have already done a preliminary review for you, and I hope to help you do a better job.

    Based on the pull request title and diff, it appears that the changes are related to updating the release versions in the documentation. The changes are limited to updating the regular expressions used for branch matching in the YAML files.

    There are no potential problems with this pull request since it is just a documentation update and it does not affect the codebase or the CI/CD pipeline.

    As for fixing suggestions, since this is just a documentation update, there are no changes required. The pull request can be merged as is. However, it is a good practice to ensure that the changes made are tested before merging.

    ti-chi-bot[bot] commented 4 days ago

    Hi @qiancai. Thanks for your PR.

    I'm waiting for a PingCAP-QE member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

    Once the patch is verified, the new status will be reflected by the ok-to-test label.

    I understand the commands that are listed here.

    Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository.
    codiumai-pr-agent-pro[bot] commented 4 days ago

    PR Reviewer Guide 🔍

    ⏱️ Estimated effort to review [1-5] 2
    🧪 Relevant tests No
    🔒 Security concerns No
    ⚡ Key issues to review None
    codiumai-pr-agent-pro[bot] commented 4 days ago

    PR Code Suggestions ✨

    CategorySuggestion                                                                                                                                    Score
    Possible issue
    Include release-5.0 in the regex if it is still supported ___ **The regex for release-5.[1-4] excludes the release-5.0 version, which was included in the
    previous pattern. If release-5.0 is still under support and needs to be included in the
    postsubmit jobs, the regex should be adjusted to reflect this.** [prow-jobs/pingcap/docs/docs-postsubmits.yaml [13]](https://github.com/PingCAP-QE/ci/pull/3020/files#diff-b1066d5a5f50efe588f78cadcc9c9441d11c1b017c00a85627e2af77af140bf7R13-R13) ```diff -- ^release-5\.[1-4]$ +- ^release-5\.[0-4]$ ``` - [ ] **Apply this suggestion**
    Suggestion importance[1-10]: 10 Why: The suggestion correctly points out that the new regex `release-5.[1-4]` excludes `release-5.0`, which was previously included. If `release-5.0` is still supported, this is a critical oversight, and the regex should be adjusted to `release-5.[0-4]` to include it.
    		10
    Adjust the regex to include all necessary minor versions for releases 6 and 7 ___ **It appears that the regex for the release branches has been modified to exclude certain
    versions that were previously included. Specifically, the regex for release-6.[15] and
    release-7.[156] might unintentionally exclude versions like release-6.2 or release-7.2,
    which were included in the previous pattern. Consider adjusting the regex to include all
    necessary minor versions if those versions still need support.** [prow-jobs/pingcap/docs/docs-cn-postsubmits.yaml [14-15]](https://github.com/PingCAP-QE/ci/pull/3020/files#diff-a8bd1b126b4211a56553a1a30b5216df53edaba89d5a577790b6832288b489e4R14-R15) ```diff -- ^release-6\.[15]$ -- ^release-7\.[156]$ +- ^release-6\.[1-5]$ +- ^release-7\.[1-6]$ ``` - [ ] **Apply this suggestion**
    Suggestion importance[1-10]: 9 Why: The suggestion correctly identifies that the new regex patterns for `release-6.[15]` and `release-7.[156]` exclude certain versions that were previously included. Adjusting the regex to `release-6.[1-5]` and `release-7.[1-6]` ensures all necessary minor versions are covered, which is crucial for maintaining proper support.
    		9
    Maintainability
    Synchronize regex patterns across different configuration files for consistency ___ **Consider maintaining consistency in the regex patterns across different configuration
    files to ensure uniform behavior. The patterns for branch releases should ideally be
    synchronized between docs-cn-postsubmits.yaml and docs-postsubmits.yaml unless
    intentionally configured otherwise.** [prow-jobs/pingcap/docs/docs-postsubmits.yaml [14-15]](https://github.com/PingCAP-QE/ci/pull/3020/files#diff-b1066d5a5f50efe588f78cadcc9c9441d11c1b017c00a85627e2af77af140bf7R14-R15) ```diff -- ^release-6\.[15]$ -- ^release-7\.[156]$ +- ^release-6\.[1-5]$ +- ^release-7\.[1-6]$ ``` - [ ] **Apply this suggestion**
    Suggestion importance[1-10]: 8 Why: Maintaining consistency in regex patterns across configuration files is important for uniform behavior and maintainability. This suggestion ensures that the patterns for branch releases are synchronized, which helps prevent configuration errors and inconsistencies.
    		8
    Enhancement
    Ensure all necessary patches for release 8 are included in the regex ___ **The addition of release-8.[0-2] is a good update, but ensure that all necessary patches
    for these versions are considered. If patches like release-8.3 are expected, they should
    be included in the regex.** [prow-jobs/pingcap/docs/docs-cn-postsubmits.yaml [16]](https://github.com/PingCAP-QE/ci/pull/3020/files#diff-a8bd1b126b4211a56553a1a30b5216df53edaba89d5a577790b6832288b489e4R16-R16) ```diff -- ^release-8\.[0-2]$ +- ^release-8\.[0-3]$ ``` - [ ] **Apply this suggestion**
    Suggestion importance[1-10]: 7 Why: The suggestion to include `release-8.3` in the regex is valid if future patches for release 8 are expected. However, without specific knowledge of the release plans, this suggestion is more of a precautionary enhancement rather than a critical fix.
    		7
    ti-chi-bot[bot] commented 4 days ago

    I have already done a preliminary review for you, and I hope to help you do a better job.

    Based on the Pull Request description and the provided diff, it seems that this PR is a configuration change that updates branch patterns in docs-cn-postsubmits.yaml and docs-postsubmits.yaml to include support for release-8.2 and removes support for release-5.0 and release-6.6 in both files.

    The key changes in this PR are as follows:

    There seem to be no potential problems with this PR, as it is just a configuration change.

    However, it is good to ensure that the configurations are tested and validated before merging the PR to the main branch.

    Suggestions:

    ti-chi-bot[bot] commented 4 days ago

    I have already done a preliminary review for you, and I hope to help you do a better job.

    Based on the PR title and description, it seems like the changeset is to update the branch patterns in docs-cn-postsubmits.yaml and docs-postsubmits.yaml to include support for release-8.2 and remove support for release-5.0 and release-6.6.

    The changes look good and there are no potential problems that I can see. It's always good to keep the supported releases up-to-date, and removing the unsupported versions will make the codebase cleaner.

    My suggestion would be to merge the PR after the CI checks pass.

    ti-chi-bot[bot] commented 4 days ago

    I have already done a preliminary review for you, and I hope to help you do a better job.

    Based on the PR title and description, the changes in this PR are related to updating the branch patterns in the docs-cn-postsubmits.yaml and docs-postsubmits.yaml files. Specifically, this PR adds support for release-8.2 and removes support for release-5.0 and release-6.6 in both files.

    The changes look good and there shouldn't be any potential problems. However, it's always good to double-check if the removed versions are not being used by anyone or any system.

    As for fixing suggestions, I don't have any since the changes appear to be straightforward and correct. However, it's always a good idea to verify the changes locally before merging the PR.

    ti-chi-bot[bot] commented 4 days ago

    I have already done a preliminary review for you, and I hope to help you do a better job.

    Based on the PR title and description, the key changes made include updating the branch patterns in docs-cn-postsubmits.yaml and docs-postsubmits.yaml to include support for release-8.2 and removing support for release-5.0 and release-6.6 in both files.

    The changes look straightforward and should not cause any issues. However, it is always a good idea to double-check the changes before merging.

    One potential problem is that the regex patterns in the branches section may not cover all possible branch names, especially for future releases. It might be a good idea to use a more generic regex pattern that can match all future release branches as well.

    Suggestions for fixing:

    ti-chi-bot[bot] commented 4 days ago

    I have already done a preliminary review for you, and I hope to help you do a better job.

    Based on the pull request title, the changeset is focused on updating the documentation PDF to include the release-8.2 and removing support for the archived versions like release-5.0 and release-6.6.

    The changes seem to be well documented and the code changeset looks good. However, there might be a potential problem when removing support for older versions like release-5.0 and release-6.6, as some users might still be using these versions. So it is recommended to communicate to the users about the removal of support for the old versions.

    As for fixing suggestions, it is recommended to add a note to the documentation or the release notes indicating that support for release-5.0 and release-6.6 has been removed and also recommend users to upgrade to the latest release version. Additionally, it is recommended to test the changes before merging to ensure that the documentation PDF is generated with the expected changes.

    ti-chi-bot[bot] commented 4 days ago

    I have already done a preliminary review for you, and I hope to help you do a better job.

    Based on the PR title and description, the changes made in this PR are related to updating the branch patterns in docs-cn-postsubmits.yaml and docs-postsubmits.yaml files. The update includes adding support for release-8.2 and removing support for release-5.0 and release-6.6 in both files.

    There are no potential problems identified in this PR.

    However, I suggest adding a short description of why the changes are needed to the PR description. This will help other reviewers to understand the purpose of the changes.

    ti-chi-bot[bot] commented 4 days ago

    I have already done a preliminary review for you, and I hope to help you do a better job.

    Based on the pull request title and description, it seems that the changes only affect the documentation configuration files docs-cn-postsubmits.yaml and docs-postsubmits.yaml. The changes include updating the branch patterns to include support for release-8.2, and removing support for release-5.0 and release-6.6 in both files.

    The pull request seems to be straightforward and does not introduce any major problems. However, there are a few suggestions for improvement:

    Overall, the pull request seems to be well-constructed and beneficial. It updates the configuration files to support the latest release of the product and removes support for older, inactive releases.

    wuhuizuo commented 4 days ago

    /lgtm

    ti-chi-bot[bot] commented 4 days ago

    [APPROVALNOTIFIER] This PR is APPROVED

    This pull-request has been approved by: wuhuizuo

    The full list of commands accepted by this bot can be found here.

    The pull request process is described here

    Needs approval from an approver in each of these files: - ~~[prow-jobs/pingcap/docs/OWNERS](https://github.com/PingCAP-QE/ci/blob/main/prow-jobs/pingcap/docs/OWNERS)~~ [wuhuizuo] Approvers can indicate their approval by writing `/approve` in a comment Approvers can cancel approval by writing `/approve cancel` in a comment
    ti-chi-bot[bot] commented 4 days ago

    [LGTM Timeline notifier]

    Timeline: