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

1697 fixed hugo depericate warning custom params #1702

Conversation

chamiz
Copy link
Contributor

@chamiz chamiz commented May 2, 2024

User description

Fixed Hugo depreciate warning "custom params on the language top level was deprecated in Hugo v0.112.0 and will be removed in Hugo 0.126.0"

Fix for #1697

Thanks for contributing to the Selenium site and documentation!
A PR well described will help maintainers to review and merge it quickly

Description

After updating hugo v0.125.4 , I'm getting "custom params on the language top level was deprecated in Hugo v0.112.0 and will be removed in Hugo 0.126.0"for several translations.

Motivation and Context

So as a fix, we need to put the values as suggested.
[languages.zh-cn.params]

Source
https://gohugo.io/content-management/multilingual/#changes-in-hugo-01120

Types of changes

  • [X ] Change to the site (I have double-checked the Netlify deployment, and my changes look good)
  • Code example added (and I also added the example to all translated languages)
  • [X ] Improved translation
  • Added new translation (and I also added a notice to each document missing translation)

Checklist

  • [ X] I have read the contributing document.
  • [ X] I have used hugo to render the site/docs locally and I am sure it works.

Type

enhancement, documentation


Description

  • Updated Hugo to version 0.125.4 in GitHub workflows, README, Netlify configuration, and website documentation.
  • Updated Docsy theme to version 0.10.0 in Go module dependencies.
  • Refactored language descriptions into parameters in hugo.toml to address deprecation warnings from Hugo.

Changes walkthrough

Relevant files
Configuration changes
deploy.yml
Update Hugo Version in Deployment Workflow                             

.github/workflows/deploy.yml

  • Updated Hugo version to 0.125.4 in the deployment workflow.
+1/-1     
test.yml
Update Hugo Version in Test Workflow                                         

.github/workflows/test.yml

  • Updated Hugo version to 0.125.4 in the test workflow.
+1/-1     
netlify.toml
Update Hugo Version in Netlify Configuration                         

netlify.toml

  • Updated Hugo version to 0.125.4 across various Netlify build contexts.

  • +3/-3     
    Documentation
    README.md
    Update Recommended Hugo Version in README                               

    README.md

    • Updated recommended Hugo version to 0.125.4 in the README.
    +1/-1     
    Dependencies
    go.mod
    Update Docsy Theme Version                                                             

    website_and_docs/go.mod

    • Updated Docsy theme version to 0.10.0.
    +1/-1     
    go.sum
    Update Go Dependencies                                                                     

    website_and_docs/go.sum

    • Updated dependencies to align with new Docsy version.
    +7/-0     
    Enhancement
    hugo.toml
    Refactor Language Descriptions to Params                                 

    website_and_docs/hugo.toml

  • Moved custom descriptions to language-specific params to comply with
    Hugo deprecation warnings.
  • +11/-6   

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

    chamiz added 4 commits May 1, 2024 02:00
    …niumHQ#1699
    
    Fixed deprecated params.
    Updated Hugo and Docsy versions
    Updated Hugo to 0.125.4
    Updated Docsy to 0.10.0
    …n-the-language-top-level' of https://github.com/chamiz/seleniumhq.github.io into SeleniumHQ#1697-Hugo-depericate-warning-custom-params-on-the-language-top-level
    Copy link

    netlify bot commented May 2, 2024

    Deploy Preview for selenium-dev ready!

    Name Link
    🔨 Latest commit 872f442
    🔍 Latest deploy log https://app.netlify.com/sites/selenium-dev/deploys/663360b5deda1d0008d0f326
    😎 Deploy Preview https://deploy-preview-1702--selenium-dev.netlify.app
    📱 Preview on mobile
    Toggle QR Code...

    QR Code

    Use your smartphone camera to open QR code link.

    To edit notification comments on pull requests, go to your Netlify site configuration.

    @codiumai-pr-agent-pro codiumai-pr-agent-pro bot added documentation Improvements or additions to documentation enhancement New feature or request labels May 2, 2024
    Copy link

    PR Description updated to latest commit (872f442)

    Copy link

    PR Review

    ⏱️ Estimated effort to review [1-5]

    2, because the changes are straightforward and mainly involve version updates and configuration adjustments. The PR is well-documented and the changes are consistent across multiple files, which simplifies the review process.

    🧪 Relevant tests

    No

    🔍 Possible issues

    No

    🔒 Security concerns

    No


    ✨ Review tool usage guide:

    Overview:
    The review tool scans the PR code changes, and generates a PR review which includes several types of feedbacks, such as possible PR issues, security threats and relevant test in the PR. More feedbacks can be added by configuring the tool.

    The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on any PR.

    • When commenting, to edit configurations related to the review tool (pr_reviewer section), use the following template:
    /review --pr_reviewer.some_config1=... --pr_reviewer.some_config2=...
    
    [pr_reviewer]
    some_config1=...
    some_config2=...
    

    See the review usage page for a comprehensive guide on using this tool.

    Copy link

    PR Code Suggestions

    CategorySuggestions                                                                                                                                                       
    Possible issue
    Remove leading space in the version number to ensure proper parsing.

    Remove the leading space in the hugo-version value to ensure consistency and prevent
    potential parsing issues.

    .github/workflows/deploy.yml [20]

    -hugo-version: ' 0.125.4'
    +hugo-version: '0.125.4'
     

    ✨ Improve tool usage guide:

    Overview:
    The improve tool scans the PR code changes, and automatically generates suggestions for improving the PR code. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on a PR.

    • When commenting, to edit configurations related to the improve tool (pr_code_suggestions section), use the following template:
    /improve --pr_code_suggestions.some_config1=... --pr_code_suggestions.some_config2=...
    
    [pr_code_suggestions]
    some_config1=...
    some_config2=...
    

    See the improve usage page for a comprehensive guide on using this tool.

    Copy link
    Member

    @diemol diemol left a comment

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    Thank you, @chamiz!

    @diemol diemol merged commit 26aa5a4 into SeleniumHQ:trunk May 2, 2024
    8 checks passed
    selenium-ci added a commit that referenced this pull request May 2, 2024
    * #1697 - Fixed Hugo depericate warning on custom params #1699
    
    Fixed deprecated params.
    Updated Hugo and Docsy versions
    
    * Updated Hugo version and Docsy versions
    
    Updated Hugo to 0.125.4
    Updated Docsy to 0.10.0
    
    [deploy site] 26aa5a4
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    documentation Improvements or additions to documentation enhancement New feature or request Review effort [1-5]: 2
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    None yet

    2 participants