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 doctor command not finding pkg-config on Solus #3670

Merged
merged 2 commits into from
Aug 10, 2024

Conversation

ianmjones
Copy link
Contributor

@ianmjones ianmjones commented Aug 8, 2024

Description

Fixed wails doctor not finding pkg-config on Solus.

On Solus, pkg-config has been replaced by the backwards compatible pkgconf package. As Solus is a rolling release, it should be safe to update the looked up package name from pkg-config to pkgconf, especially as wails doctor is informational and does not affect whether wails build etc can find pkg-config.

Before Fix:

wails-doctor-on-solus-pkg-config-missing

After Fix:

wails-doctor-on-solus-pkg-config-found

Fixes #3669

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?

Ran wails doctor on an up to date Solus install, where wails build works fine. 😄

  • Windows
  • macOS
  • Linux

Test Configuration

See screenshots!

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

  • New Features

    • Updated package name from "pkg-config" to "pkgconf," reflecting a semantic change in package naming.
  • Documentation

    • Improved clarity in the changelog with minor textual corrections and a new entry regarding the doctor command issue on Solus.

Copy link
Contributor

coderabbitai bot commented Aug 8, 2024

Walkthrough

This update primarily changes the identification of the pkg-config package to pkgconf within the package manager's codebase, ensuring compatibility with the Solus operating system. Additionally, minor adjustments were made to the changelog to enhance clarity, including documenting a fix related to the doctor command's ability to recognize the pkgconf package. These changes aim to improve user experience and maintain accuracy in package management.

Changes

Files Change Summary
v2/internal/system/packagemanager/eopkg.go Renamed pkg-config to pkgconf in the Packages function to reflect the correct package used in Solus.
website/src/pages/changelog.mdx Minor textual corrections in the changelog; added a new entry about the doctor command recognizing pkgconf.

Assessment against linked issues

Objective Addressed Explanation
Doctor command not finding pkg-config on Solus (#3669)

🐇 In the garden where changes bloom,
A name transformed, dispelling gloom.
No more confusion, pkgconf is clear,
With hops of joy, we cheer and cheer!
A changelog tidy, a fix on the way,
Let's celebrate this brand new day! 🌼✨


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 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 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 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 as 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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

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

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.

Copy link

sonarcloud bot commented Aug 8, 2024

@ianmjones ianmjones marked this pull request as ready for review August 8, 2024 08:32
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.

Actionable comments posted: 0

Outside diff range, codebase verification and nitpick comments (1)
v2/internal/system/packagemanager/eopkg.go (1)

43-43: Update all occurrences of "pkg-config" to ensure consistency

The change from "pkg-config" to "pkgconf" in eopkg.go is not isolated. Other parts of the codebase still use "pkg-config", which could lead to inconsistencies. Consider updating the following occurrences:

  • v2/internal/system/system.go: Update the command execution to use "pkgconf" if applicable.
  • v2/internal/system/system_linux.go: Ensure the dependency check aligns with the new package name.
  • v2/internal/system/packagemanager/dnf.go: Verify if "pkgconf-pkg-config" is the intended package.
  • v2/internal/system/packagemanager/apt.go: Update the package name if "pkgconf" is the correct package.
  • v2/internal/system/packagemanager/nixpkgs.go: Ensure the package naming aligns with "pkgconf".
  • v2/internal/system/packagemanager/pacman.go: Verify the use of "pkgconf".
  • v2/internal/system/packagemanager/emerge.go: Confirm "dev-util/pkgconf" is correct.
  • v2/internal/system/packagemanager/zypper.go: Ensure consistency with "pkgconf-pkg-config".
  • v2/internal/system/packagemanager/packagemanager.go: Update the command execution and version check.
Analysis chain

LGTM! Verify the impact of the pkgconf change.

The change from "pkg-config" to "pkgconf" is approved and aligns with the PR objectives.

Ensure that this change does not affect other parts of the codebase that might rely on the old package name.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the impact of changing "pkg-config" to "pkgconf" in the codebase.

# Test: Search for occurrences of "pkg-config" in the codebase. Expect: No remaining occurrences.
rg --type go '"pkg-config"'

Length of output: 1156


Script:

#!/bin/bash
# Description: Review each file where "pkg-config" is mentioned to determine if they should be updated to "pkgconf".

# List files with "pkg-config" and show context around each occurrence.
rg --type go '"pkg-config"' -A 3 -B 3

Length of output: 5867

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between ddf2703 and 10ba45e.

Files selected for processing (2)
  • v2/internal/system/packagemanager/eopkg.go (1 hunks)
  • website/src/pages/changelog.mdx (1 hunks)
Files skipped from review due to trivial changes (1)
  • website/src/pages/changelog.mdx

Copy link
Member

@leaanthony leaanthony left a comment

Choose a reason for hiding this comment

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

Thanks so much @ianmjones! 🙏

@leaanthony leaanthony merged commit 2b35861 into wailsapp:master Aug 10, 2024
13 checks passed
@ianmjones ianmjones deleted the fix-solus-doctor branch August 10, 2024 09:17
therealsamf pushed a commit to therealsamf/wails that referenced this pull request Aug 29, 2024
* Fix doctor command not finding pkg-config on Solus

* Update changelog
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.

Doctor command not finding pkg-config on Solus
2 participants