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

The package available via dnf is in a good place #879

Merged
merged 1 commit into from
Feb 25, 2025
Merged

The package available via dnf is in a good place #879

merged 1 commit into from
Feb 25, 2025

Conversation

ericcurtin
Copy link
Collaborator

@ericcurtin ericcurtin commented Feb 24, 2025

Defaulting to that on platforms that have dnf, if it fails for whatever reason, fall back to this script.

Summary by Sourcery

This pull request modifies the installation script to first attempt to install ramalama using dnf if it is available. If dnf is not available or the installation fails, the script falls back to the existing installation method. The installation process is also refactored into separate functions for installing the binary and libraries.

New Features:

  • Adds support for installing ramalama via the dnf package manager on systems where it is available.

Enhancements:

  • Refactors the installation process into separate functions for installing the binary and libraries.

Copy link
Contributor

sourcery-ai bot commented Feb 24, 2025

Reviewer's Guide by Sourcery

This pull request introduces dnf support for installing ramalama on relevant platforms. It also refactors the setup_ramalama function to improve code organization and readability by extracting the binary and library installation steps into separate functions.

Sequence diagram for ramalama installation with dnf

sequenceDiagram
  participant User
  participant install.sh
  participant dnf
  participant GitHub

  User->>install.sh: Executes install.sh
  install.sh->>install.sh: Checks if dnf is available
  alt dnf is available
    install.sh->>dnf: Installs python3-ramalama
    alt Installation successful
      dnf-->>install.sh: Success
      install.sh-->>User: ramalama installed via dnf
    else Installation failed
      dnf-->>install.sh: Failure
      install.sh->>GitHub: Downloads ramalama files
      GitHub-->>install.sh: ramalama files
      install.sh->>install.sh: Installs ramalama from files
      install.sh-->>User: ramalama installed from files
    end
  else dnf is not available
    install.sh->>GitHub: Downloads ramalama files
    GitHub-->>install.sh: ramalama files
    install.sh->>install.sh: Installs ramalama from files
    install.sh-->>User: ramalama installed from files
  end
Loading

Flow diagram for ramalama installation process

graph TD
    A[Start install.sh] --> B{dnf available?}
    B -- Yes --> C{Install python3-ramalama with dnf}
    C -- Success --> D[ramalama installed]
    C -- Fail --> E[Download ramalama from GitHub]
    B -- No --> E
    E --> F[Install ramalama from files]
    F --> D
Loading

File-Level Changes

Change Details Files
Added support for installing ramalama via dnf on platforms where it is available.
  • Added a check for the availability of dnf.
  • Attempt to install ramalama using dnf install -y python3-ramalama.
  • If dnf installation succeeds, the function returns, skipping the rest of the installation process.
install.sh
Refactored the setup_ramalama function to improve readability and modularity.
  • Extracted the binary installation steps into a new function called install_ramalama_bin.
  • Extracted the library installation steps into a new function called install_ramalama_libs.
  • The setup_ramalama function now calls the new functions install_ramalama_bin and install_ramalama_libs.
install.sh

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @ericcurtin - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider adding a comment explaining why the dnf install command might fail.
  • It might be better to move the core logic of installing the python files into a separate function, and call that function from both the dnf and non-dnf paths.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Defaulting to that on platforms that have dnf, if it fails for
whatever reason, fall back to this script.

Signed-off-by: Eric Curtin <ecurtin@redhat.com>
Copy link
Member

@engelmi engelmi left a comment

Choose a reason for hiding this comment

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

LGTM

@ericcurtin ericcurtin merged commit 3721dd9 into main Feb 25, 2025
17 checks passed
@ericcurtin ericcurtin deleted the dnf branch February 25, 2025 14:43
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