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

Fix for Go 1.24 support #4064

Closed
wants to merge 2 commits into from
Closed

Conversation

VdanielVPL
Copy link

@VdanielVPL VdanielVPL commented Feb 12, 2025

Description

This PR fixes wails for go1.24. I tested the changes by running wails in my own project.

Fixes #4060

Type of change

Please select the option that is 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

Wails

Version | v2.9.2

System

┌────────────────────────────────────────────────────────────────────────┐
| OS           | Windows 10 Pro                                          |
| Version      | 2009 (Build: 26100)                                     |
| ID           | 24H2                                                    |
| Go Version   | go1.24.0                                                |
| Platform     | windows                                                 |
| Architecture | amd64                                                   |
| CPU          | Intel(R) Core(TM) i7-9700K CPU @ 3.60GHz                |
| GPU          | NVIDIA GeForce GTX 1080 (NVIDIA) - Driver: 32.0.15.7216 |
| Memory       | 32GB                                                    |
└────────────────────────────────────────────────────────────────────────┘

# Dependencies
┌────────────────────────────────────────────────────────┐
| Dependency | Package Name | Status    | Version        |
| WebView2   | N/A          | Installed | 132.0.2957.140 |
| Nodejs     | N/A          | Installed | 22.11.0        |
| npm        | N/A          | Installed | 10.9.0         |
| *upx       | N/A          | Available |                |
| *nsis      | N/A          | Available |                |
└─────────────── * - Optional Dependency ────────────────┘

# Diagnosis
Optional package(s) installation details:
  - upx : Available at https://upx.github.io/
  - nsis : More info at https://wails.io/docs/guides/windows-installer/

 SUCCESS  Your system is ready for Wails development!

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

  • Chores
    • Upgraded several third-party libraries to their latest stable versions, enhancing overall compatibility, performance, and security.

Copy link
Contributor

coderabbitai bot commented Feb 12, 2025

Walkthrough

The v2/go.mod file has been updated to bump several dependency versions in the require section of the github.com/wailsapp/wails/v2 module. The changes include version upgrades for eight dependencies from their previous releases to newer ones. Additionally, the changelog.mdx file has been modified to include a new entry for a fix related to launching Wails for Go version 1.24 and to remove outdated documentation, maintaining the overall structure of the changelog.

Changes

File Change Summary
v2/go.mod Updated dependency versions: golang.org/x/mod v0.22.0 → v0.23.0, golang.org/x/net v0.34.0 → v0.35.0, golang.org/x/sys v0.29.0 → v0.30.0, golang.org/x/tools v0.29.0 → v0.30.0, golang.org/x/crypto v0.32.0 → v0.33.0, golang.org/x/sync v0.10.0 → v0.11.0, golang.org/x/term v0.28.0 → v0.29.0, golang.org/x/text v0.21.0 → v0.22.0.
website/src/pages/changelog.mdx Added fix for launching Wails for Go 1.24 (updated tools package) and removed outdated documentation reference regarding the default module name in go.mod.

Suggested reviewers

  • leaanthony

Poem

I hopped through code with eager glee,
Updating versions so smoothly, you see.
Dependencies grew to a fresher state,
A rabbit’s work, precise and great!
With a wiggle and a hop, my lines align,
Cheers to changes, crisp and fine! 🐰


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5776c75 and c6fcce6.

📒 Files selected for processing (1)
  • website/src/pages/changelog.mdx (1 hunks)
🔇 Additional comments (1)
website/src/pages/changelog.mdx (1)

37-37: LGTM! The changelog entry is well-formatted and provides good context.

The entry correctly documents the Go 1.24 compatibility fix under the "Fixed" section, with proper PR reference and attribution.


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>, please review it.
    • Generate unit testing code 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 testing code 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • 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/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@Snider
Copy link
Contributor

Snider commented Feb 12, 2025

You can test all the available OS versions for GitHub Actions with this.

https://github.com/dAppServer/wails-build-action/blob/main/.github/workflows/build-tests.yml

@VdanielVPL
Copy link
Author

@Snider Should I make another branch for this workflow or how do I do it?

@Snider
Copy link
Contributor

Snider commented Feb 12, 2025

@Snider Should I make another branch for this workflow or how do I do it?

EDIT: I just realised I might need to adjust https://github.com/dAppServer/wails-build-action/blob/main/action.yml#L190 so you can test wails itself.... gimmie a few min

You could do that, then link it here to prove it builds on Mac/Linux without pushing the workflow into the Wails repo.

I have triggers for these:

on:
  push:
    branches: [ "main", "v2", "v3", "dev", "*-*" ]
  pull_request:
    branches: [ "main", "v2", "v3", "dev", "*-*" ]
  # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:

So, branch name: 4064-buildtest would trigger GHAs on your fork. You can also trigger the workflow directly in GHA once the workflow is present.

@leaanthony
Copy link
Member

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

@Snider
Copy link
Contributor

Snider commented Feb 12, 2025

As with everything in life, that was way harder than I thought.

So, my action now has the option wails-dev-build when set to true. Go, and Wails are not installed inside the action and must be provided before calling the composite action.

https://github.com/Snider/wails/actions/runs/13293300380/job/37119067860
https://github.com/Snider/wails/blob/dev-build/.github/workflows/gha-tests.yml

So, this builds for 1.22, so just adjust go to 1.24 for your use; if there is interest in using the GHA for testing wails ability to build on GHA, I can smarten it up a lot more, move the setup inside the action & add wails maintainers to the repo.

  ubuntu2404:
    runs-on: ubuntu-24.04
    steps:
      - name: Checkout
        uses: actions/checkout@v4
      - name: Setup Go
        uses: actions/setup-go@v5
        with:
          go-version: 1.22
          cache-dependency-path: ./v2/go.sum
      - name: Build Wails CLI
        run: |
          cd ./v2/cmd/wails
          go install
          wails -help
      - name: Generate & Build template
        run: |
          mkdir -p ./test-plain
          cd ./test-plain
          wails init -n plain -t plain -ci
          cd plain
      - uses: dAppServer/wails-build-action@main
        with:
          wails-dev-build: "true"
          app-working-directory: test-plain/plain
          build-name: wails
          build-platform: linux/amd64
          wails-build-webview2: "embed"
          package: false # Do not try to upload to GitHub

@VdanielVPL
Copy link
Author

I don't know if I did it right, but these are the results:

go 1.22 in workflow: https://github.com/VdanielVPL/wails/actions/runs/13294205043

go 1.24 in workflow: https://github.com/VdanielVPL/wails/actions/runs/13294277491

@Snider
Copy link
Contributor

Snider commented Feb 12, 2025

It looks good to me, you did it right. The MacOS failure is not your fault; it's my action's weirdness. If the Wails guys want to use the action, I'll fix it; otherwise, it works well enough for this.

@leaanthony
Copy link
Member

I've fixed this in v2.9.3. You have to install that specific version and not @latest for some go module weirdness

@leaanthony leaanthony closed this Feb 13, 2025
@VdanielVPL VdanielVPL deleted the patch-1 branch February 13, 2025 21:27
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.

package "context" without types was imported
3 participants