Skip to content

Commit

Permalink
(chocolatey#2050) Upgrade add parameter to ignore pins
Browse files Browse the repository at this point in the history 
This adds a switch to the upgrade command to bypass/ignore any pinned
packages. It will write out a warning message if a pinned package is
being upgraded.

The package will remain pinned after the upgrade completes, although
pinned to the new version.
  • Loading branch information
@TheCakeIsNaOH @gep13
TheCakeIsNaOH authored and gep13 committed Apr 25, 2024
1 parent 3813ac3 commit fb22630
Show file tree
Hide file tree
Showing 4 changed files with 35 additions and 9 deletions.
2 changes: 1 addition & 1 deletion src/chocolatey.resources/helpers/ChocolateyTabExpansion.ps1
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ $commandOptions = @{
install = "-y -whatif --pre --version= --params='' --install-arguments='' --override-arguments --ignore-dependencies --source='' --source='windowsfeatures' --user='' --password='' --prerelease --forcex86 --not-silent --package-parameters='' --exit-when-reboot-detected --ignore-detected-reboot --allow-downgrade --force-dependencies --require-checksums --use-package-exit-codes --ignore-package-exit-codes --skip-automation-scripts --ignore-checksums --allow-empty-checksums --allow-empty-checksums-secure --download-checksum='' --download-checksum-type='' --download-checksum-x64='' --download-checksum-type-x64='' --stop-on-first-package-failure --disable-package-repository-optimizations --pin"
pin = "--name='' --version=''"
outdated = "--source='' --user='' --password='' --ignore-pinned --ignore-unfound --pre --prerelease --disable-package-repository-optimizations"
upgrade = "-y -whatif --pre --version='' --except='' --params='' --install-arguments='' --override-arguments --ignore-dependencies --source='' --source='windowsfeatures' --user='' --password='' --prerelease --forcex86 --not-silent --package-parameters='' --exit-when-reboot-detected --ignore-detected-reboot --allow-downgrade --require-checksums --use-package-exit-codes --ignore-package-exit-codes --skip-automation-scripts --fail-on-unfound --fail-on-not-installed --ignore-checksums --allow-empty-checksums --allow-empty-checksums-secure --download-checksum='' --download-checksum-type='' --download-checksum-x64='' --download-checksum-type-x64='' --exclude-prerelease --stop-on-first-package-failure --use-remembered-options --ignore-remembered-options --skip-when-not-installed --install-if-not-installed --disable-package-repository-optimizations --pin"
upgrade = "-y -whatif --pre --version='' --except='' --params='' --install-arguments='' --override-arguments --ignore-dependencies --source='' --source='windowsfeatures' --user='' --password='' --prerelease --forcex86 --not-silent --package-parameters='' --exit-when-reboot-detected --ignore-detected-reboot --allow-downgrade --require-checksums --use-package-exit-codes --ignore-package-exit-codes --skip-automation-scripts --fail-on-unfound --fail-on-not-installed --ignore-checksums --allow-empty-checksums --allow-empty-checksums-secure --download-checksum='' --download-checksum-type='' --download-checksum-x64='' --download-checksum-type-x64='' --exclude-prerelease --stop-on-first-package-failure --use-remembered-options --ignore-remembered-options --skip-when-not-installed --install-if-not-installed --disable-package-repository-optimizations --pin --ignore-pinned"
uninstall = "-y -whatif --force-dependencies --remove-dependencies --all-versions --source='windowsfeatures' --version= --uninstall-arguments='' --override-arguments --not-silent --params='' --package-parameters='' --exit-when-reboot-detected --ignore-detected-reboot --use-package-exit-codes --ignore-package-exit-codes --skip-automation-scripts --use-autouninstaller --skip-autouninstaller --fail-on-autouninstaller --ignore-autouninstaller-failure --stop-on-first-package-failure"
new = "--template-name='' --output-directory='' --automaticpackage --version='' --maintainer='' packageversion='' maintainername='' maintainerrepo='' installertype='' url='' url64='' silentargs='' --use-built-in-template"
pack = "--version='' --output-directory=''"
Expand Down
4 changes: 4 additions & 0 deletions src/chocolatey/infrastructure.app/commands/ChocolateyUpgradeCommand.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -250,6 +250,10 @@ public virtual void ConfigureArgumentParser(OptionSet optionSet, ChocolateyConfi
"Skip hooks - Do not run hook scripts. Available in 1.2.0+",
option => configuration.SkipHookScripts = option != null
)
.Add("ignore-pinned",
"Ignore Pinned - Ignores any pins and upgrades the package(s) anyway. Available in 2.3.0+",
option => configuration.UpgradeCommand.IgnorePinned = option != null
)
;
}

Expand Down
1 change: 1 addition & 0 deletions src/chocolatey/infrastructure.app/configuration/ChocolateyConfiguration.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -600,6 +600,7 @@ public sealed class UpgradeCommandConfiguration
public bool NotifyOnlyAvailableUpgrades { get; set; }
public string PackageNamesToSkip { get; set; }
public bool ExcludePrerelease { get; set; }
public bool IgnorePinned { get; set; }
}

[Serializable]
Expand Down
37 changes: 29 additions & 8 deletions src/chocolatey/infrastructure.app/services/NugetService.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1108,7 +1108,7 @@ public virtual ConcurrentDictionary<string, PackageResult> Upgrade(ChocolateyCon
var pkgInfo = _packageInfoService.Get(installedPackage.PackageMetadata);
var isPinned = pkgInfo != null && pkgInfo.IsPinned;

if (isPinned && config.OutdatedCommand.IgnorePinned)
if (isPinned && config.OutdatedCommand.IgnorePinned && !config.UpgradeCommand.IgnorePinned)
{
continue;
}
Expand Down Expand Up @@ -1246,15 +1246,31 @@ public virtual ConcurrentDictionary<string, PackageResult> Upgrade(ChocolateyCon

if (isPinned)
{
var logMessage = "{0} is pinned. Skipping pinned package.".FormatWith(packageName);
packageResult.Messages.Add(new ResultMessage(ResultType.Warn, logMessage));
packageResult.Messages.Add(new ResultMessage(ResultType.Inconclusive, logMessage));
if (config.RegularOutput)
if (!config.UpgradeCommand.IgnorePinned)
{
this.Log().Warn(ChocolateyLoggers.Important, logMessage);
var logMessage = "{0} is pinned. Skipping pinned package.".FormatWith(packageName);
packageResult.Messages.Add(new ResultMessage(ResultType.Warn, logMessage));
packageResult.Messages.Add(new ResultMessage(ResultType.Inconclusive, logMessage));

if (config.RegularOutput)
{
this.Log().Warn(ChocolateyLoggers.Important, logMessage);
}

continue;
}
else
{
var logMessage = "{0} is pinned. Upgrading pinned package anyway as ignore pin is specified".FormatWith(packageName);
packageResult.Messages.Add(new ResultMessage(ResultType.Warn, logMessage));

continue;
if (config.RegularOutput)
{
this.Log().Warn(ChocolateyLoggers.Important, logMessage);
}

config.PinPackage = true;
}
}

if (performAction)
Expand Down Expand Up @@ -1326,7 +1342,12 @@ public virtual ConcurrentDictionary<string, PackageResult> Upgrade(ChocolateyCon
}
}

var removedSources = RemovePinnedSourceDependencies(sourcePackageDependencyInfos, allLocalPackages);
var removedSources = new HashSet<SourcePackageDependencyInfo>();

if (!config.UpgradeCommand.IgnorePinned)
{
RemovePinnedSourceDependencies(sourcePackageDependencyInfos, allLocalPackages);
}

if (version != null || removedSources.Count == 0)
{
Expand Down

0 comments on commit fb22630

Please sign in to comment.