Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update version.json #5867

Closed
wants to merge 1 commit into from
Closed

Update version.json #5867

wants to merge 1 commit into from

Conversation

buger
Copy link
Member

@buger buger commented Jan 7, 2025

User description

This pull request updates the version.json file


PR Type

enhancement


Description

  • Updated versions.json to include new version 9.

  • Added explicit entry for version 5.7.

  • Removed unnecessary trailing whitespace in the file.

  • Ensured consistent formatting and structure in versions.json.


Changes walkthrough 📝

Relevant files
Enhancement
versions.json
Added version 9 and improved JSON structure                           

scripts/versions.json

  • Added new version 9 with path and branch.
  • Introduced explicit entry for version 5.7.
  • Removed trailing whitespace for cleaner formatting.
  • Maintained consistent structure across version entries.
  • +7/-4     

    💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

    Copy link
    Contributor

    github-actions bot commented Jan 7, 2025

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ Recommended focus areas for review

    Formatting Consistency

    Ensure that the formatting changes, such as the removal of trailing whitespace and the addition of new entries, maintain the intended structure and do not introduce any unintended issues in versions.json.

    [
        {
            "path": "/docs/",
            "name": "9 - Latest",
            "branch": "release-9"
        },
        {
            "path": "/docs/5.7/",
            "name": "5.7",
            "branch": "release-5.7"
        },
        {
            "path": "/docs/5.6/",
            "name": "5.6",
            "branch": "release-5.6"
        },
        {
            "path": "/docs/5.5/",
            "name": "5.5",
            "branch": "release-5.5"
        },
        {
            "path": "/docs/5.4/",
            "name": "5.4",
            "branch": "release-5.4"
        },
        {
            "path": "/docs/5.3/",
            "name": "5.3 - LTS",
            "branch": "release-5.3"
        },
        {
            "path": "/docs/5.2/",
            "name": "5.2",
            "branch": "release-5.2"
        },
        {
            "path": "/docs/5.1/",
            "name": "5.1",
            "branch": "release-5.1"
        },
        {
            "path": "/docs/5.0/",
            "name": "5 - LTS",
            "branch": "release-5"
        },
        {
            "path": "/docs/4.3/",
            "name": "4.3",
            "branch": "release-4.3"
        },
        {
            "path": "/docs/4.2/",
            "name": "4.2",
            "branch": "release-4.2"
        },
        {
            "path": "/docs/4.1/",
            "name": "4.1",
            "branch": "release-4.1"
        },
        {
            "path": "/docs/4.0/",
            "name": "4 - LTS",
            "branch": "release-4"
        },
        {
            "path": "/docs/3.2/",
            "name": "3.2",
            "branch": "release-3.2"
        },
        {
            "path": "/docs/3.1/",
            "name": "3.1",
            "branch": "release-3.1"
        },
        {
            "path": "/docs/3-lts/",
            "name": "3 - LTS",
            "branch": "release-3-lts"
        },
        {
            "path": "/docs/nightly/",
            "name": "Nightly",
            "branch": "master"
        }
    ]
    Version Accuracy

    Verify that the new version entries (e.g., version 9 and version 5.7) are accurate and align with the intended release structure.

        "name": "9 - Latest",
        "branch": "release-9"
    },
    {
        "path": "/docs/5.7/",
        "name": "5.7",
        "branch": "release-5.7"

    Copy link
    Contributor

    github-actions bot commented Jan 7, 2025

    PR Code Suggestions ✨

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Score
    General
    Adjust the version naming to maintain consistency with the established naming convention

    Ensure that the "name" field for the latest version is consistent with the naming
    convention used for previous versions to avoid confusion or misrepresentation.

    scripts/versions.json [4-7]

     {
         "path": "/docs/",
    -    "name": "9 - Latest",
    +    "name": "9.0 - Latest",
         "branch": "release-9"
     },
    Suggestion importance[1-10]: 8

    Why: The suggestion improves consistency in the naming convention for version identifiers, aligning the latest version's name with the format used for previous versions. This reduces potential confusion and enhances clarity in the versioning scheme.

    8

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    2 participants