Initial chocolatey.config configuration file is initialized with empty descriptions #3201
Closed
4 tasks done
Comments
4 tasks
|
This issue is related to this issue as they both have the same root cause. |
10 tasks
10 tasks
gep13
added a commit
to gep13/choco
that referenced
this issue
Jun 23, 2023
Previously, in this commit: chocolatey@da19356#diff-cb6a0471e41268b22a928bd57a59d51b70b7024e9beb30e89a330e193a089eba The usage of the top level CacheLocation and CommandExecutionTimeoutSeconds values had been removed, since these top level properties within the chocolatey.config had been replaced with values contained within the config section of the chocolatey.config file. However, the changes in that commit were too aggressive, and removed the call to the set_config_item (which has subsequently been renamed to SetConfigItem). The method call does the work of taking any value that is defined in the chocolatey.config for a given property name, and adding it to the ChocolateyConfiguration instance. When this method call was removed, it stopped setting the property value on the instance, and as a result, values that had been configured in the chocolatey.config file were ignored. They were still in play when the configuration was passed in via a command line option, but not when defining them in the chocolatey.config file. The removal of this call to the set_config_item method also explains why it was necessary to apply this bug fix in Chocolatey GUI: chocolatey/ChocolateyGUI#1003 The method call also had the effect of setting the description on the configuration value, which would have meant that Chocolatey GUI wouldn't have thrown a null reference exception. The change in Chocolatey GUI is still valid though, as there are times when a config value can have a missing description, so it makes sense to leave that fix in place.
corbob
pushed a commit
to gep13/choco
that referenced
this issue
Jun 23, 2023
Previously, in this commit: chocolatey@da19356#diff-cb6a0471e41268b22a928bd57a59d51b70b7024e9beb30e89a330e193a089eba The usage of the top level CacheLocation and CommandExecutionTimeoutSeconds values had been removed, since these top level properties within the chocolatey.config had been replaced with values contained within the config section of the chocolatey.config file. However, the changes in that commit were too aggressive, and removed the call to the set_config_item (which has subsequently been renamed to SetConfigItem). The method call does the work of taking any value that is defined in the chocolatey.config for a given property name, and adding it to the ChocolateyConfiguration instance. When this method call was removed, it stopped setting the property value on the instance, and as a result, values that had been configured in the chocolatey.config file were ignored. They were still in play when the configuration was passed in via a command line option, but not when defining them in the chocolatey.config file. The removal of this call to the set_config_item method also explains why it was necessary to apply this bug fix in Chocolatey GUI: chocolatey/ChocolateyGUI#1003 The method call also had the effect of setting the description on the configuration value, which would have meant that Chocolatey GUI wouldn't have thrown a null reference exception. The change in Chocolatey GUI is still valid though, as there are times when a config value can have a missing description, so it makes sense to leave that fix in place.
gep13
changed the title
gep13
added a commit
that referenced
this issue
Jun 29, 2023
* release/2.1.0: (52 commits) (maint) If statement formatting change (#3224) Add Assembly Loaded configuration option (maint) Resave without BOM (#3224) Update version check tests (#3174) Store non-normalized package version (maint) Add required whitespace (#3225) Add Pester Tests to ensure environment (#3201 #3225) Re-instate setting of config values (maint) Remove env variable for release version (maint) Fix encoding of file (#3194) Add tab completion for cache command (#2854) Re-save file with UTF-8 with BOM (#3218) Update Tab Expansion to use Test-Path (#3218) Remove try catch block for tab completion (build) Use latest Chocolatey.Cake.Recipe package (#2854) Do Write-Error instead of Write-Warning (#2854) Pester tests to Get-ChocolateyConfigValue (maint) Resave Get-ChocolateyConfigValue as CRLF (#2854) Add helper to read config values (#3214) Add Pester tests to ensure cache cleared ...
|
🎉 This issue has been resolved in version 2.1.0 🎉 The release is available on: Your GitReleaseManager bot 📦🚀 |
gep13
added a commit
that referenced
this issue
Jun 29, 2023
* master: (maint) If statement formatting change (#3224) Add Assembly Loaded configuration option (maint) Resave without BOM (#3224) Update version check tests (#3174) Store non-normalized package version (maint) Add required whitespace (#3225) Add Pester Tests to ensure environment (#3201 #3225) Re-instate setting of config values (maint) Remove env variable for release version (maint) Fix encoding of file (#3194) Add tab completion for cache command (#2854) Re-save file with UTF-8 with BOM (#3218) Update Tab Expansion to use Test-Path (#3218) Remove try catch block for tab completion
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Checklist
What You Are Seeing?
Right after installing Chocolatey CLI to v2.0.0, the configuration file that gets initialized is missing the description for the elements
cacheLocation,containsLegacyPackageInstallsandcommandExecutionTimeoutSeconds. This causes issues with Chocolatey GUI due to it not handling empty descriptions. While this is something that needs to be fixed in Chocolatey GUI, we should also ensure that the description gets added when the configuration file is created.What is Expected?
There should not be any empty/missing descriptions in the configuration file.
How Did You Get This To Happen?
%ChocolateyInstall%\config\chocolatey.configSystem Details
Installed Packages
Output Log
Additional Context
No response
The text was updated successfully, but these errors were encountered: