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

remove chocolatey installer after installing package #2697

Merged
merged 2 commits into from
Nov 7, 2024

Conversation

imolorhe
Copy link
Collaborator

@imolorhe imolorhe commented Nov 7, 2024

Fixes

Closes #2173

Checks

  • Ran yarn test-build
  • Updated relevant documentations
  • Updated matching config options in altair-static

Changes proposed in this pull request:

Summary by Sourcery

Bug Fixes:

  • Remove the Chocolatey installer after installing the package to prevent leftover files.

Copy link

sourcery-ai bot commented Nov 7, 2024

Reviewer's Guide by Sourcery

The PR adds cleanup functionality to remove the installer file after successfully installing a package using Chocolatey. This is implemented by adding a try-catch block that attempts to delete the installer file using PowerShell's Remove-Item cmdlet with error handling.

Sequence diagram for Chocolatey package installation and cleanup

sequenceDiagram
    participant User
    participant Chocolatey
    participant FileSystem

    User->>Chocolatey: Install package
    Chocolatey->>FileSystem: Install-ChocolateyPackage
    FileSystem-->>Chocolatey: Package installed
    Chocolatey->>FileSystem: Remove-Item (installer)
    alt Installer removed successfully
        FileSystem-->>Chocolatey: Success
    else Failed to remove installer
        FileSystem-->>Chocolatey: Error
        Chocolatey->>User: Write-Error "Failed to remove the installer"
    end
Loading

File-Level Changes

Change Details Files
Added cleanup functionality to remove installer file after package installation
  • Added try-catch block for safe file removal
  • Used Remove-Item cmdlet with -Force and -SilentlyContinue parameters for robust file deletion
  • Added error logging if file removal fails
chocolatey/tools/chocolateyInstall.ps1

Assessment against linked issues

Issue Objective Addressed Explanation
#2173 Remove old version shims from C:\ProgramData\chocolatey\bin after package updates The PR only adds code to remove the installer file after installation. It does not address the issue of old version shims remaining in the Chocolatey bin directory after updates.

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.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a 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. You can also use
    this command to specify where the summary should be inserted.

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

@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 @imolorhe - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider streamlining the error handling approach - either remove -ErrorAction 'SilentlyContinue' to let the catch block handle errors naturally, or remove the try-catch entirely if cleanup failures should be ignored silently.
Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 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.

Comment on lines 21 to 25
try {
# Remove the installer
Remove-Item $fileLocation -Force -ErrorAction 'SilentlyContinue'
} catch {
Write-Error "Failed to remove the installer: $_"
Copy link

Choose a reason for hiding this comment

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

suggestion: The error handling approach is inconsistent - using both SilentlyContinue and try-catch

Consider removing the try-catch block and keeping just the Remove-Item with -ErrorAction 'SilentlyContinue' since this is just a cleanup operation

Suggested change
try {
# Remove the installer
Remove-Item $fileLocation -Force -ErrorAction 'SilentlyContinue'
} catch {
Write-Error "Failed to remove the installer: $_"
Remove-Item $fileLocation -Force -ErrorAction 'SilentlyContinue'

Copy link

github-actions bot commented Nov 7, 2024

Visit the preview URL for this PR (updated for commit 31c5fe3):

https://altair-gql--pr2697-imolorhe-remove-choc-5lfz0p69.web.app

(expires Thu, 14 Nov 2024 10:38:08 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

Sign: 02d6323d75a99e532a38922862e269d63351a6cf

@imolorhe imolorhe added this pull request to the merge queue Nov 7, 2024
Merged via the queue into master with commit c06e930 Nov 7, 2024
14 checks passed
@imolorhe imolorhe deleted the imolorhe/remove-chocolatey-installer-after-install branch November 7, 2024 14:21
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.

[BUG] Chocolatey package leaves old version shims
1 participant