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 go minimum version #3285

Merged
merged 5 commits into from
Mar 24, 2024
Merged

update go minimum version #3285

merged 5 commits into from
Mar 24, 2024

Conversation

lmb1113
Copy link
Contributor

@lmb1113 lmb1113 commented Feb 29, 2024

V2.7.1 Go 1.20 is now the minimum supported Go version.

Description

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Fixes # (issue)

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration using wails doctor.

  • Windows
  • macOS
  • Linux

Test Configuration

Please paste the output of wails doctor. If you are unable to run this command, please describe your environment in as much detail as possible.

Checklist:

  • I have updated website/src/pages/changelog.mdx with details of this PR
  • My code follows the general coding style of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

Summary by CodeRabbit

  • Documentation
    • Updated the installation guide to reflect the new requirements for Go and Node versions for Wails installation.
    • Increased the minimum required Go version from 1.18 to 1.20.
    • Adjusted the minimum required Node version from 15 to 15+.

V2.7.1 Go 1.20 is now the minimum supported Go version.
Copy link
Contributor

coderabbitai bot commented Feb 29, 2024

Walkthrough

This update signifies a significant advancement in the Wails development environment requirements, notably shifting the Go and Node version prerequisites. The minimum Go version has been raised from 1.18 to 1.20, ensuring users can leverage the latest enhancements and security features. Concurrently, the Node version requirement remains stable at 15+, ensuring compatibility without mandating an update.

Changes

Files Change Summary
.../versioned_docs/version-v2.8.0/gettingstarted/installation.mdx Updated Go version requirement from 1.18+ to 1.20+; Node version requirement remains at 15+.
v2/internal/goversion/min.go Updated minimum Go version requirement from "1.18" to "1.20" in the MinRequirement constant.

🐇✨
In the realm of code, where bits align,
Versions leap, oh so divine.
Go strides forth, with Node abreast,
Together stronger, passing the test.
A dance of versions, a rhythmic trance,
Wails users, embrace this advance.
🚀🌟

Related issues

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit-tests for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit tests for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 3bf4ea5 and 69502b3.
Files selected for processing (1)
  • website/versioned_docs/version-v2.8.0/gettingstarted/installation.mdx (1 hunks)
Additional comments: 4
website/versioned_docs/version-v2.8.0/gettingstarted/installation.mdx (4)
  • 18-18: The update of the Go version requirement from 1.18+ to 1.20+ is correctly documented. This change aligns with the PR's objective to update the minimum supported version of Go for the project. It's important to ensure that all references to Go versions in the documentation and code comments are updated to reflect this change.
  • 18-18: The Node version requirement remains at 15+, as mentioned in the PR summary. This documentation correctly reflects the current requirement, indicating no change in the Node version requirement. It's good practice to periodically review these requirements to ensure they align with the latest versions and project needs.
  • 18-18: While the Go version requirement update is correctly documented, it's also essential to ensure that any downstream dependencies or project components that rely on specific Go features or behavior are tested and verified to work with Go 1.20+. This includes any build scripts, CI/CD pipelines, or Dockerfiles that specify a Go version.
  • 18-18: The documentation mentions running wails doctor to check for correct dependencies. Given the update to the Go version requirement, it's crucial to ensure that the wails doctor command itself and any related diagnostic tools are updated to recognize and validate the new Go version requirement. This helps maintain a consistent and reliable setup experience for users.

@stffabi
Copy link
Collaborator

stffabi commented Mar 1, 2024

Thanks for this, would it be also possible for you to update the build constraints here/v2/internal/goversion/ ? That would be awesome 🙏

@lmb1113
Copy link
Contributor Author

lmb1113 commented Mar 1, 2024

谢谢您,您是否也可以在这里更新构建约束/v2/internal/goversion/?那就太棒了🙏

Thanks for this, would it be also possible for you to update the build constraints here/v2/internal/goversion/ ? That would be awesome 🙏

Very honored

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 69502b3 and 2b40927.
Files selected for processing (1)
  • v2/internal/goversion/min.go (1 hunks)
Additional comments: 1
v2/internal/goversion/min.go (1)
  • 3-3: The update of the MinRequirement constant to "1.20" correctly reflects the PR's objective to support Go 1.20 as the minimum version. Ensure that:
  • All project dependencies are compatible with Go 1.20.
  • The documentation, especially the changelog and installation guides, is updated to reflect this change.
  • The project has been thoroughly tested on Go 1.20 across Windows, macOS, and Linux to ensure full functionality.

@leaanthony
Copy link
Member

leaanthony commented Mar 2, 2024

Thanks for this! I see you've updated the docs for v2.8, which will eventually be deleted. Would it be possible to update website/docs/gettingstarted/installation.mdx instead? This would allow us to keep the change moving forward 🙏

@lmb1113
Copy link
Contributor Author

lmb1113 commented Mar 4, 2024

Thanks for this! I see you've updated the docs for v2.8, which will eventually be deleted. Would it be possible to update website/docs/gettingstarted/installation.mdx instead? This would allow us to keep the change moving forward 🙏

ok

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 2b40927 and 14e4fce.
Files selected for processing (1)
  • website/docs/gettingstarted/installation.mdx (1 hunks)
Files skipped from review due to trivial changes (1)
  • website/docs/gettingstarted/installation.mdx

@leaanthony
Copy link
Member

Thanks 🙏 Please could you add an entry to the changelog located at website/src/pages/changelog.mdx?

@lmb1113
Copy link
Contributor Author

lmb1113 commented Mar 18, 2024

Thanks 🙏 Please could you add an entry to the changelog located at website/src/pages/changelog.mdx?

It already exists.

@leaanthony
Copy link
Member

The PR contains an update to a versioned doc. We will lose that eventually 👍

@leaanthony leaanthony merged commit 08a71de into wailsapp:master Mar 24, 2024
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants