Skip to content

Commit

Permalink
Merge pull request #757 from gep13/stable-release-notes
Browse files Browse the repository at this point in the history
Add notes for 2.1.0 and 6.1.0 Chocolatey products
  • Loading branch information
gep13 authored Jun 29, 2023
2 parents 84f9415 + b83be69 commit 3ffea37
Show file tree
Hide file tree
Showing 76 changed files with 588 additions and 83 deletions.
15 changes: 15 additions & 0 deletions input/en-us/agent/release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,21 @@ This covers the release notes for the Chocolatey Agent Service (`chocolatey-agen
<?! Include "../../shared/chocolatey-component-dependencies.txt" /?>


## 2.1.0 (June 29, 2023)

> :choco-warning: **WARNING**
>
> Refer to our [Upgrade Guide](xref:upgrading-to-chocolatey-v2-v6) for recommendations before upgrading from 1.x versions to 2.x.
### Bug Fix

- Fix - Outdated packages are not being reported to Chocolatey Central Management Service.

### Improvement

- Make use of option to skip HTTP cache when running Chocolatey CLI commands.


## 2.0.0 (May 31, 2023)

> :choco-warning: **WARNING**
Expand Down
181 changes: 181 additions & 0 deletions input/en-us/choco/commands/cache.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,181 @@
---
Order: 5
xref: choco-command-cache
Title: Cache
Description: Cache Command (choco cache)
RedirectFrom:
- docs/commandscache
- docs/commands-cache
---

<!-- This file is automatically generated based on output from https://github.com/chocolatey/choco/blob/master/src/chocolatey/infrastructure.app/commands/ChocolateyCacheCommand.cs using https://github.com/chocolatey/choco/blob/master/GenerateDocs.ps1. Contributions are welcome at the original location(s). If the file is not found, it is not part of the open source edition of Chocolatey or the name of the file is different. -->

# Cache Command (choco cache)

> :choco-warning: **WARNING**
>
> This command was introduced in Chocolatey CLI v2.1.0
Get the statistics of what Chocolatey CLI has cached or clear any cached
items in the current context.

The behavior of this command will vary depending on whether it is running in an elevated context or not.
Statistics and removing cached items will always happen on the User HTTP Cache.
However, the System HTTP Cache will only be considered if running in an elevated context.

## Usage

choco cache [list]|remove [options/switches]

## Examples

choco cache
choco cache list
choco cache remove
choco cache remove --expired

> :choco-info: **NOTE** See scripting in [how to pass arguments](xref:choco-commands#how-to-pass-options-switches) (`choco -?`) for how to
write proper scripts and integrations.

## Exit Codes

Exit codes that normally result from running this command.

Normal:
- 0: operation was successful, no issues detected
- -1 or 1: an error has occurred

If you find other exit codes that we have not yet documented, please
file a ticket so we can document it at
https://github.com/chocolatey/choco/issues/new/choose.


## Options and Switches

> :choco-info: **NOTE**
>
> Options and switches apply to all items passed, so if you are
running a command like install that allows installing multiple
packages, and you use `--version=1.0.0`, it is going to look for and
try to install version 1.0.0 of every package passed. So please split
out multiple package calls when wanting to pass specific options.

Includes [default options/switches](xref:choco-commands#default-options-and-switches) (included below for completeness).

~~~
-?, --help, -h
Prints out the help menu.
--online
Online - Open help for specified command in default browser application.
This option only works when used in combintation with the -?/--help/-h
option. Available in 2.0.0+
-d, --debug
Debug - Show debug messaging.
-v, --verbose
Verbose - Show verbose messaging. Very verbose messaging, avoid using
under normal circumstances.
--trace
Trace - Show trace messaging. Very, very verbose trace messaging. Avoid
except when needing super low-level .NET Framework debugging.
--nocolor, --no-color
No Color - Do not show colorization in logging output. This overrides
the feature 'logWithoutColor', set to 'False'.
--acceptlicense, --accept-license
AcceptLicense - Accept license dialogs automatically. Reserved for
future use.
-y, --yes, --confirm
Confirm all prompts - Chooses affirmative answer instead of prompting.
Implies --accept-license
-f, --force
Force - force the behavior. Do not use force during normal operation -
it subverts some of the smart behavior for commands.
--noop, --whatif, --what-if
NoOp / WhatIf - Don't actually do anything.
-r, --limitoutput, --limit-output
LimitOutput - Limit the output to essential information
--timeout, --execution-timeout=VALUE
CommandExecutionTimeout (in seconds) - The time to allow a command to
finish before timing out. Overrides the default execution timeout in the
configuration of 2700 seconds. Supply '0' to disable the timeout.
-c, --cache, --cachelocation, --cache-location=VALUE
CacheLocation - Location for download cache, defaults to %TEMP% or value
in chocolatey.config file.
--allowunofficial, --allow-unofficial, --allowunofficialbuild, --allow-unofficial-build
AllowUnofficialBuild - When not using the official build you must set
this flag for choco to continue.
--failstderr, --failonstderr, --fail-on-stderr, --fail-on-standard-error, --fail-on-error-output
FailOnStandardError - Fail on standard error output (stderr), typically
received when running external commands during install providers. This
overrides the feature failOnStandardError.
--use-system-powershell
UseSystemPowerShell - Execute PowerShell using an external process
instead of the built-in PowerShell host. Should only be used when
internal host is failing.
--no-progress
Do Not Show Progress - Do not show download progress percentages.
--proxy=VALUE
Proxy Location - Explicit proxy location. Overrides the default proxy
location of ''.
--proxy-user=VALUE
Proxy User Name - Explicit proxy user (optional). Requires explicit
proxy (`--proxy` or config setting). Overrides the default proxy user of
''.
--proxy-password=VALUE
Proxy Password - Explicit proxy password (optional) to be used with
username. Requires explicit proxy (`--proxy` or config setting) and user
name. Overrides the default proxy password (encrypted in settings if
set).
--proxy-bypass-list=VALUE
ProxyBypassList - Comma separated list of regex locations to bypass on
proxy. Requires explicit proxy (`--proxy` or config setting). Overrides
the default proxy bypass list of ''.
--proxy-bypass-on-local
Proxy Bypass On Local - Bypass proxy for local connections. Requires
explicit proxy (`--proxy` or config setting). Overrides the default
proxy bypass on local setting of 'True'.
--log-file=VALUE
Log File to output to in addition to regular loggers.
--skipcompatibilitychecks, --skip-compatibility-checks
SkipCompatibilityChecks - Prevent warnings being shown before and after
command execution when a runtime compatibility problem is found between
the version of Chocolatey and the Chocolatey Licensed Extension.
Available in 1.1.0+
--ignore-http-cache
IgnoreHttpCache - Ignore any HTTP caches that have previously been
created when querying sources, and create new caches. Available in 2.1.0+
--expired
Expired - Remove cached items that have expired.
~~~

[Command Reference](xref:choco-commands)


*> :choco-info: **NOTE*** This documentation has been automatically generated from `choco cache -h`.

9 changes: 7 additions & 2 deletions input/en-us/choco/commands/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ Includes [default options/switches](xref:choco-commands#default-options-and-swit
--online
Online - Open help for specified command in default browser application.
This option only works when used in combintation with the -?/--help/-h
option.
option. Available in 2.0.0+
-d, --debug
Debug - Show debug messaging.
Expand Down Expand Up @@ -165,7 +165,12 @@ Includes [default options/switches](xref:choco-commands#default-options-and-swit
--skipcompatibilitychecks, --skip-compatibility-checks
SkipCompatibilityChecks - Prevent warnings being shown before and after
command execution when a runtime compatibility problem is found between
the version of Chocolatey and the Chocolatey Licensed Extension.
the version of Chocolatey and the Chocolatey Licensed Extension.
Available in 1.1.0+
--ignore-http-cache
IgnoreHttpCache - Ignore any HTTP caches that have previously been
created when querying sources, and create new caches. Available in 2.1.0+
--name=VALUE
Name - the name of the config setting. Required with some actions.
Expand Down
9 changes: 9 additions & 0 deletions input/en-us/choco/commands/download.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,11 @@ Includes [default options/switches](xref:choco-commands#default-options-and-swit
-?, --help, -h
Prints out the help menu.
--online
Online - Open help for specified command in default browser application.
This option only works when used in combintation with the -?/--help/-h
option. Available in 2.0.0+
-d, --debug
Debug - Show debug messaging.
Expand Down Expand Up @@ -170,6 +175,10 @@ Includes [default options/switches](xref:choco-commands#default-options-and-swit
command execution when a runtime compatibility problem is found between
the version of Chocolatey and the Chocolatey Licensed Extension.
--ignore-http-cache
IgnoreHttpCache - Ignore any HTTP caches that have previously been
created when querying sources, and create new caches. Available in 2.1.0+
-s, --source=VALUE
Source - The source to find the package(s) to download. Defaults to
default feeds.
Expand Down
6 changes: 5 additions & 1 deletion input/en-us/choco/commands/export.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ Includes [default options/switches](xref:choco-commands#default-options-and-swit
--online
Online - Open help for specified command in default browser application.
This option only works when used in combintation with the -?/--help/-h
option.
option. Available in 2.0.0+
-d, --debug
Debug - Show debug messaging.
Expand Down Expand Up @@ -167,6 +167,10 @@ Includes [default options/switches](xref:choco-commands#default-options-and-swit
the version of Chocolatey and the Chocolatey Licensed Extension.
Available in 1.1.0+
--ignore-http-cache
IgnoreHttpCache - Ignore any HTTP caches that have previously been
created when querying sources, and create new caches. Available in 2.1.0+
-o, --output-file-path=VALUE
Output File Path - the path to where the list of currently installed
packages should be saved. Defaults to packages.config.
Expand Down
6 changes: 5 additions & 1 deletion input/en-us/choco/commands/feature.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ Includes [default options/switches](xref:choco-commands#default-options-and-swit
--online
Online - Open help for specified command in default browser application.
This option only works when used in combintation with the -?/--help/-h
option.
option. Available in 2.0.0+
-d, --debug
Debug - Show debug messaging.
Expand Down Expand Up @@ -161,6 +161,10 @@ Includes [default options/switches](xref:choco-commands#default-options-and-swit
the version of Chocolatey and the Chocolatey Licensed Extension.
Available in 1.1.0+
--ignore-http-cache
IgnoreHttpCache - Ignore any HTTP caches that have previously been
created when querying sources, and create new caches. Available in 2.1.0+
-n, --name=VALUE
Name - the name of the source. Required with actions other than list.
Defaults to empty.
Expand Down
6 changes: 5 additions & 1 deletion input/en-us/choco/commands/features.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ Includes [default options/switches](xref:choco-commands#default-options-and-swit
--online
Online - Open help for specified command in default browser application.
This option only works when used in combintation with the -?/--help/-h
option.
option. Available in 2.0.0+
-d, --debug
Debug - Show debug messaging.
Expand Down Expand Up @@ -163,6 +163,10 @@ Includes [default options/switches](xref:choco-commands#default-options-and-swit
the version of Chocolatey and the Chocolatey Licensed Extension.
Available in 1.1.0+
--ignore-http-cache
IgnoreHttpCache - Ignore any HTTP caches that have previously been
created when querying sources, and create new caches. Available in 2.1.0+
-n, --name=VALUE
Name - the name of the source. Required with actions other than list.
Defaults to empty.
Expand Down
18 changes: 11 additions & 7 deletions input/en-us/choco/commands/find.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ Includes [default options/switches](xref:choco-commands#default-options-and-swit
--online
Online - Open help for specified command in default browser application.
This option only works when used in combintation with the -?/--help/-h
option.
option. Available in 2.0.0+
-d, --debug
Debug - Show debug messaging.
Expand Down Expand Up @@ -184,6 +184,10 @@ Includes [default options/switches](xref:choco-commands#default-options-and-swit
the version of Chocolatey and the Chocolatey Licensed Extension.
Available in 1.1.0+
--ignore-http-cache
IgnoreHttpCache - Ignore any HTTP caches that have previously been
created when querying sources, and create new caches. Available in 2.1.0+
-s, --source=VALUE
Source - Source location for install. Can use special 'windowsfeatures',
'ruby', 'cygwin', or 'python' sources. Defaults to sources.
Expand Down Expand Up @@ -261,12 +265,12 @@ Includes [default options/switches](xref:choco-commands#default-options-and-swit
Detailed - Alias for verbose.
--disable-repository-optimizations, --disable-package-repository-optimizations
Disable Package Repository Optimizations - Do not use optimizations for
reducing bandwidth with repository queries during package
install/upgrade/outdated operations. Should not generally be used,
unless a repository needs to support older methods of query. When
disabled, this makes queries similar to the way they were done in
Chocolatey v0.10.11 and before. Overrides the default feature
Disable Package Repository Optimizations - Do not use optimizations for
reducing bandwidth with repository queries during package
install/upgrade/outdated operations. Should not generally be used,
unless a repository needs to support older methods of query. When
disabled, this makes queries similar to the way they were done in
earlier versions of Chocolatey. Overrides the default feature
'usePackageRepositoryOptimizations' set to 'True'.
--audit, --showaudit, --show-audit, --show-audit-info
Expand Down
7 changes: 6 additions & 1 deletion input/en-us/choco/commands/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ This is a listing of all of the different things you can pass to choco.
## Commands

* [apikey](xref:choco-command-apikey) - retrieves, saves or deletes an API key for a particular source
* [cache](xref:choco-command-cache) - Manage the local HTTP caches used to store queries (v2.1.0+)
* [config](xref:choco-command-config) - Retrieve and configure config file settings
* [convert](xref:choco-command-convert) - converts packages from one type to another type
* [download](xref:choco-command-download) - downloads packages - optionally internalizing all remote resources
Expand Down Expand Up @@ -222,7 +223,7 @@ Following these scripting best practices will ensure your scripts work
--online
Online - Open help for specified command in default browser application.
This option only works when used in combintation with the -?/--help/-h
option.
option. Available in 2.0.0+
-d, --debug
Debug - Show debug messaging.
Expand Down Expand Up @@ -317,6 +318,10 @@ Following these scripting best practices will ensure your scripts work
the version of Chocolatey and the Chocolatey Licensed Extension.
Available in 1.1.0+
--ignore-http-cache
IgnoreHttpCache - Ignore any HTTP caches that have previously been
created when querying sources, and create new caches. Available in 2.1.0+
~~~


Expand Down
Loading

0 comments on commit 3ffea37

Please sign in to comment.