Skip to content

fix: correct Windows filename in generate:icons task - #4219

Merged
leaanthony merged 2 commits into
wailsapp:v3-alphafrom
yulesxoxo:v3-alpha
Apr 18, 2025
Merged

leaanthony merged 2 commits into
wailsapp:v3-alphafrom
yulesxoxo:v3-alpha

Conversation

@yulesxoxo

@yulesxoxo yulesxoxo commented Apr 16, 2025 •

Copy link
Copy Markdown
Contributor

Description

wails3 task common:generate:icons will now generate icon.ico instead of icons.ico

Fixes #4217

This was fixed here before: #4125
I imagine it broke during a refactor or was missed which is unfortunate but happens.

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

If you checked Linux, please specify the distro and version.

Test Configuration

# System 

┌────────────────────────────────────────────────────────────────────────────────────────────┐
| Name              | Windows 10 Pro                                                         |
| Version           | 2009 (Build: 26100)                                                    |
| ID                | 24H2                                                                   |
| Branding          | Windows 11 Pro                                                         |
| Platform          | windows                                                                |
| Architecture      | amd64                                                                  |
| Go WebView2Loader | true                                                                   |
| WebView2 Version  | 135.0.3179.73                                                          |
| CPU               | 13th Gen Intel(R) Core(TM) i7-13700K                                   |
| GPU 1             | NVIDIA GeForce RTX 4090 (NVIDIA) - Driver: 32.0.15.7270                |
| GPU 2             | Intel(R) UHD Graphics 770 (Intel Corporation) - Driver: 32.0.101.6129  |
| Memory            | 64GB                                                                   |
└────────────────────────────────────────────────────────────────────────────────────────────┘

# Build Environment 

┌────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
| Wails CLI      | v3.0.0-alpha.9                                                                                                            |
| Go Version     | go1.23.4                                                                                                                  |
| -buildmode     | exe                                                                                                                       |
| -compiler      | gc                                                                                                                        |
| CGO_CFLAGS     |                                                                                                                           |
| CGO_CPPFLAGS   |                                                                                                                           |
| CGO_CXXFLAGS   |                                                                                                                           |
| CGO_ENABLED    | 1                                                                                                                         |
| CGO_LDFLAGS    |                                                                                                                           |
| DefaultGODEBUG | asynctimerchan=1,gotypesalias=0,httpservecontentkeepheaders=1,tls3des=1,tlskyber=0,x509keypairleaf=0,x509negativeserial=1 |
| GOAMD64        | v1                                                                                                                        |
| GOARCH         | amd64                                                                                                                     |
| GOOS           | windows                                                                                                                   |
└────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘

# Dependencies 

┌───────────────────────────┐
| npm  | 10.9.0             |
| NSIS | Not Installed      |
└─ * - Optional Dependency ─┘

# Diagnosis 

 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

  • Bug Fixes
    • Corrected the Windows icon file name from icons.ico to icon.ico in documentation and task configuration.
  • Documentation
    • Updated changelog to reflect the icon file name fix.
    • Improved formatting and default values in the icon command flags documentation.

@coderabbitai

coderabbitai Bot commented Apr 16, 2025 •

Copy link
Copy Markdown
Contributor

Walkthrough

This set of changes updates documentation and build configuration to correct the Windows icon filename from icons.ico to icon.ico. The changelog is amended to record the fix, the command-line documentation is updated to reflect the correct default value, and the build task configuration is modified to generate the icon with the correct filename. No changes are made to exported or public entities, and no code logic is altered.

Changes

File(s) Change Summary
docs/src/content/docs/changelog.mdx Added a changelog entry under "Unreleased" for the Windows icon filename fix, referencing PR #4219.
v3/cmd/wails3/README.md Updated the documentation table for the icon command flags: fixed formatting and corrected default values for Windows and Mac filenames.
v3/examples/file-association/build/Taskfile.common.yml Changed the generated Windows icon filename in the generate:icons task from icons.ico to icon.ico.

Sequence Diagram(s)

sequenceDiagram
    participant Developer
    participant TaskRunner
    participant FileSystem

    Developer->>TaskRunner: Run generate:icons task
    TaskRunner->>FileSystem: Generate icon.ico for Windows
    FileSystem-->>TaskRunner: icon.ico created
    TaskRunner-->>Developer: Task complete
Loading

Assessment against linked issues

Objective Addressed Explanation
The generate:icons task should generate icon.ico for Windows (Issue #4217) ✅

Possibly related PRs

Suggested reviewers

  • leaanthony

Poem

A hop, a skip, a filename tweak,
Now "icon.ico" is what we seek!
No more plural, just the one,
Windows icons—fix is done!
🐰✨
Changelog noted, docs aligned,
A tidy patch—how well designed!

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)
  • We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between afb4bd9 and b3cd25c.

📒 Files selected for processing (3)
  • docs/src/content/docs/changelog.mdx (1 hunks)
  • v3/cmd/wails3/README.md (1 hunks)
  • v3/examples/file-association/build/Taskfile.common.yml (1 hunks)
🔇 Additional comments (3)
docs/src/content/docs/changelog.mdx (1)

118-118: Changelog entry is clear and accurate.

The new entry correctly documents the bug fix and follows project conventions.

v3/examples/file-association/build/Taskfile.common.yml (1)

59-59: Windows icon filename corrected.

The output filename is now icon.ico, matching the intended fix and documentation.

v3/cmd/wails3/README.md (1)

24-30: Documentation now matches actual icon output filenames.

Flag defaults and formatting are correct and consistent with the build configuration.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
  • @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.

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.

@sonarqubecloud

Copy link
Copy Markdown

@leaanthony leaanthony left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks for fixing the example

@leaanthony
leaanthony merged commit 7453df5 into wailsapp:v3-alpha Apr 18, 2025
Grantmartin2002 pushed a commit to Grantmartin2002/wails that referenced this pull request Apr 29, 2026
fix: correct Windows filename in generate:icons task
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.

2 participants