Skip to content

Commit

Permalink
Merge branch 'chocolatey:master' into (chocolatey#1028)-docs-update-f…
Browse files Browse the repository at this point in the history
…ix-emojis
  • Loading branch information
LeaDevelop authored Dec 14, 2024
2 parents 1e85e84 + 7994a24 commit 5dc00b5
Show file tree
Hide file tree
Showing 44 changed files with 2,940 additions and 1,728 deletions.
19 changes: 13 additions & 6 deletions .github/workflows/stale.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ jobs:
stale:
runs-on: ubuntu-latest
steps:
# Action GitHub repository: https://github.com/actions/stale
- uses: actions/stale@v9
id: stale
with:
Expand All @@ -20,13 +21,14 @@ jobs:
exempt-all-assignees: false
exempt-draft-pr: true
stale-issue-label: "Pending Closure"
stale-pr-label: 'Pending Closure'
only-labels: '0 - Waiting on User'
stale-pr-label: "Pending Closure"
only-labels: "0 - Waiting on User"
close-issue-label: "No Response / Stale"
close-issue-reason: "not_planned"
close-pr-label: "No Response / Stale"
exempt-issue-labels: 'Security / CVE,2 - Working,3 - Review'
exempt-pr-labels: 'Security / CVE,2 - Working,3 - Review'
labels-to-remove-when-unstale: '0 - Waiting on User,Pending closure'
exempt-issue-labels: "Security,2 - Working,3 - Review"
exempt-pr-labels: "Security,2 - Working,3 - Review"
labels-to-remove-when-unstale: "0 - Waiting on User,Pending closure"
remove-stale-when-updated: true
stale-issue-message: |
Is this still relevant? If so, what is blocking it? Is there anything you can do to help move it forward?
Expand All @@ -37,13 +39,18 @@ jobs:
As this issue seems to have been inactive for quite some time now, it has been automatically closed.
If you feel this is a valid issue, please feel free to re-open the issue if / when a pull request
has been added.
Thank you for your contribution.
Thank you for your contribution.
stale-pr-message: |
Is this still relevant? If so, what is blocking it? Is there anything you can do to help move it forward?
This pull request will be closed in 14 days if it continues to be inactive.
close-pr-message: |
Dear contributor,
As this PR seems to have been inactive for 30 days after changes / additional information
was requested, it has been automatically closed.
If you feel the changes are still valid, please re-open the PR once all changes or additional information
that was requested has been added.
Thank you for your contribution.
50 changes: 50 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,56 @@ The [Chocolatey Design System](https://design.chocolatey.org) and [choco-astro](

[Mermaid](https://mermaid.js.org/) via an [Astro integration](https://github.com/chocolatey/choco-astro/blob/main/astro.config.mjs.json) allows an easy way to display information with diagrams written in markdown. Find more information on usage at the [choco-astro repository](https://github.com/chocolatey/choco-astro?tab=readme-ov-file#markdown-diagrams-with-mermaid).

## Adding A New Highlight

A Highlight is what is shown on the home page of docs.chocolatey.org and the left sidebar. These need updated every so often, especially when there has been a new release. Follow the steps below to add a new Highlight.

### Front Page Highlight

For front page highlights, we should try to keep it to less than 6 highlights. When adding a new one, consider editting existing highlights to set `showOnHome` to `false`.

1. Navigate to `src/content/docs/en-us/highlights` then into the current year folder.
1. Copy an existing file.
1. Change the name of the new file to include the month number as the first characters in the name, such as `10-testing-home.md`.
1. Fill in details needed and follow the current naming convention for xrefs in the file.
1. Change the `ctaText` value to something unique.

### Left Sidebar Highlight

For left sidebar highlights, we want to keep it to a minimum to reduce the amount the navigation is pushed down the page. It's recommended to edit only the top highlight file to link to the current highlighted article, and leave the bottom one to link to all highlights.

To edit either of these highlights:

1. Navigate to `src/content/docs/en-us/highlights`.
1. Find the highlight you want to edit: `00-top-sidebar-highlight.md` for the top one, and `99-bottom-sidebar-highlight.md` for the bottom one.
1. Edit the details as desired making note of the following `highlight` front matter settings that control the destination and link text:
```markdown
ctaXref: highlights
ctaAnchor: december-2024
ctaText: View December's highlights
```

If it's decided that extra highlights should be added:

1. Navigate to `src/content/docs/en-us/highlights`.
1. Copy one of the existing `*sidebar-highlight.md` files.
1. Change the name of the new file to start with a number that will determine it's order in the sidebar, such as `10-testing-home-sidebar-highlight.md`. Ensure the `-sidebar-highlight` in the name is retained.
1. In the nested `highlight` front matter, ensure the following are set in the nested `highlight` front matter:
```markdown
showOnHome: false
showOnHighlights: false
showInSidebar: true
```
1. Fill in the rest of the details needed and follow the current naming convention for xrefs in the file.
1. Change the `ctaText` value to something unique.
1. If there is a Sidebar Highlight already active, find the file that it is referencing. The title and post date can be a clue as to what file this is inside of the `src/content/docs/en-us/highlights` folder.
1. In the nested `highlight` front matter on the OLD file, ensure the following are set:
```markdown
showOnHome: false
showOnHighlights: false
showInSidebar: false
```

## Running Playwright Tests

To run all the Playwright tests, first run the following command:
Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
"choco-theme": "npx --quiet ts-node --skipIgnore node_modules/choco-theme/build/choco-theme.ts --repository=docs"
},
"dependencies": {
"choco-astro": "0.1.1",
"choco-theme": "0.8.1"
"choco-astro": "0.1.3",
"choco-theme": "0.8.2"
}
}
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 5 additions & 5 deletions src/components/docs/ChocolateyComponentDependencies.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,12 @@ Please refer to our <Xref title="Support Lifecycle information" value="chocolate

| Package Name / Dependency | chocolatey | chocolatey.extension | chocolateygui |
| ------------------------------ | ----------- | -------------------- | ------------- |
| chocolatey v2.3.0 | | | |
| chocolatey.extension v6.2.1 | v2.0.0 | | |
| chocolatey-agent v2.1.3 | | v6.0.0 | |
| chocolatey v2.4.1 | | | |
| chocolatey.extension v6.3.0 | v2.0.0 | | |
| chocolatey-agent v2.2.1 | | v6.0.0 | |
| chocolateygui v2.1.1 | v2.0.0 | | |
| chocolateygui.extension v2.0.0 | | v6.0.0 | v2.0.0 |
| chocolatey v1.4.0 | | | |
| chocolatey v1.4.1 | | | |
| chocolatey.extension v5.0.6 | v1.2.0 | | |
| chocolatey-agent v1.1.4 | | v4.0.0 | |
| chocolateygui v1.1.3 | v1.0.0 | | |
Expand Down Expand Up @@ -55,4 +55,4 @@ Please refer to our <Xref title="Support Lifecycle information" value="chocolate
* chocolatey

This will ensure that all dependencies, both direct and indirect, are installed.
</Callout>
</Callout>
18 changes: 18 additions & 0 deletions src/content/docs/en-us/agent/release-notes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,24 @@ This covers the release notes for the Chocolatey Agent Service (`chocolatey-agen

<ChocolateyComponentDependenciesLink />

## 2.2.1 (December 9, 2024) \{#v2.2.1}

### Bug Fix

- Fix - Invalid cron expression for LogCleanerJob.

## 2.2.0 (December 4, 2024) \{#v2.2.0}

Read our [blog post](https://blog.chocolatey.org/2024/12/announcing-agent-220-release) about this release.

### Feature

- Implement Background Job Management System.

### Improvement

- Add scheduled retry logic when installing Chocolatey Central Management Certificates.

## 2.1.3 (June 5, 2024) \{#v2.1.3}

Read our [blog post](https://blog.chocolatey.org/2024/06/announcing-cli-230-cle-620-agent213-releases/) about this release.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This document is meant to serve as a guide for where to look when needing to ren

## Set-NexusCert.ps1

This script should be saved on your repository server at `C:\choco-setup\scripts\Set-NexusCert.ps1`.
This script should be saved on your repository server at `C:\choco-setup\files\scripts\Set-NexusCert.ps1`.

You can [download the Set-NexusCert.ps1 file directly](https://github.com/chocolatey/choco-quickstart-scripts/blob/main/scripts/Set-NexusCert.ps1), or copy the below code and save it manually.

Expand Down Expand Up @@ -125,7 +125,7 @@ Write-Host -BackgroundColor Black -ForegroundColor DarkGreen "The script has suc

## Set-CCMCert.ps1

This script should be saved on your repository server at `C:\choco-setup\scripts\Set-CCMCert.ps1`.
This script should be saved on your repository server at `C:\choco-setup\files\scripts\Set-CCMCert.ps1`.

You can [download the Set-CCMCert.ps1 file directly](https://github.com/chocolatey/choco-quickstart-scripts/blob/main/scripts/Set-CCMCert.ps1), or copy the below code and manually save it.

Expand Down Expand Up @@ -216,7 +216,7 @@ process {

## Set-JenkinsCert.ps1

A version of this script may already be saved on your repository server at `C:\choco-setup\scripts\Set-JenkinsCert.ps1`.
A version of this script may already be saved on your repository server at `C:\choco-setup\files\scripts\Set-JenkinsCert.ps1`.

```powershell
<#
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -209,29 +209,25 @@ export const callout4 = {

```powershell
Set-Location "$env:SystemDrive\choco-setup\files"
.\Set-SslSecurity.ps1 -Thumbprint '<YOUR_CUSTOM_SSL_CERT_THUMBPRINT_HERE>' -Hardened
.\Set-SslSecurity.ps1 -Thumbprint '<YOUR_CUSTOM_SSL_CERT_THUMBPRINT_HERE>'
```

<Callout type="warning">
If you are using your own SSL certificate, be sure to place this certificate in the `Local Machine > Personal` certificate store before running the above script, and ensure that the private key is exportable.
</Callout>

<Callout type="info">
You may have noticed the `-Hardened` parameter we've added above. When using a custom SSL certificate, this parameter will further secure access to your C4B Server. A Role and User credential will be configured to limit access to your Nexus repositories. As well, CCM Client and Service Salts are configured to further encrypt your connection between CCM and your endpoint clients. These additional settings are also incorporated into your `Register-C4bEndpoint.ps1` script for onboarding endpoints. We do require you to enable this option if your C4B Server will be Internet-facing, with a FQDN that resolves to a public IP.
</Callout>

**ALTERNATIVE 2 : Wildcard SSL Certificate** - If you have a wildcard certificate, you will also need to provide a DNS name you wish to use for that certificate:

```powershell
Set-Location "$env:SystemDrive\choco-setup\files"
.\Set-SslSecurity.ps1 -Thumbprint '<YOUR_CUSTOM_SSL_CERT_THUMBPRINT_HERE>' -CertificateDnsName '<YOUR_DESIRED_FQDN_HERE>' -Hardened
.\Set-SslSecurity.ps1 -Thumbprint '<YOUR_CUSTOM_SSL_CERT_THUMBPRINT_HERE>' -CertificateDnsName '<YOUR_DESIRED_FQDN_HERE>'
```

For example, with a wildcard certificate with a thumbprint of `deee9b2fabb24bdaae71d82286e08de1` you wish to use `chocolatey.foo.org`, the following would be required:

```powershell
Set-Location "$env:SystemDrive\choco-setup\files"
.\Set-SslSecurity.ps1 -Thumbprint deee9b2fabb24bdaae71d82286e08de1 -CertificateDnsName chocolatey.foo.org -Hardened
.\Set-SslSecurity.ps1 -Thumbprint deee9b2fabb24bdaae71d82286e08de1 -CertificateDnsName chocolatey.foo.org
```

<br />
Expand All @@ -240,6 +236,8 @@ export const callout4 = {
> <summary><strong>What does this script do? (click to expand)</strong></summary>
> <ul class="list-style-type-disc">
> <li>Adds SSL certificate configuration for Nexus and CCM web portals</li>
> <li>A Role and User credential are configured to limit access to your Nexus repositories</li>
> <li>CCM Client and Service Salts are configured to further encrypt the connection between CCM and your endpoint clients</li>
> <li>Generates a `Register-C4bEndpoint.ps1` script for you to easily set up endpoint clients</li>
> <li>Outputs data to a JSON file to pass between scripts</li>
> <li>Writes a Readme.html file to the Public Desktop with account information for C4B services</li>
Expand Down
1 change: 1 addition & 0 deletions src/content/docs/en-us/central-management/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ Chocolatey Central Management has specific needs that are mostly handled by pack

|Chocolatey Central Management|Chocolatey Agent|Chocolatey Licensed Extension|Chocolatey|
|-----------------------------|----------------|-----------------------------|----------|
|0.13.1 |1.1.0+ | 4.2.0+ | 1.1.0+ |
|0.13.0 |1.1.0+ | 4.2.0+ | 1.1.0+ |
|0.12.1 |1.1.0+ | 4.2.0+ | 1.1.0+ |
|0.12.0 |1.1.0+ | 4.2.0+ | 1.1.0+ |
Expand Down
8 changes: 8 additions & 0 deletions src/content/docs/en-us/central-management/release-notes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,14 @@ This covers the release notes for the Chocolatey Central Management (`chocolatey

- Please see our [GitHub repository issues](https://github.com/chocolatey/chocolatey-licensed-issues/labels/CentralManagement).

## 0.13.1 (October 16, 2024) \{#v0.13.1}

### Bug Fixes

- Fix - Description for `Allow users to register to the system` checkbox in the Chocolatey Central Management Website is incorrect.
- Fix - The `Machine contact timeout in minutes` input box is incorrectly disabled when attempting to edit Deployment Step in Chocolatey Central Management Website.
- Fix - Azure SQL is incorrectly reported as not supported during Chocolatey Central Management package installations.

## 0.13.0 (September 19, 2024) \{#v0.13.0}

<Callout type="warning">
Expand Down
44 changes: 44 additions & 0 deletions src/content/docs/en-us/choco/release-notes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,49 @@ This covers changes for the "chocolatey" and "chocolatey.lib" packages, which ar

<ChocolateyComponentDependenciesLink />

## 2.4.1 (Dec 4, 2024) \{#v2.4.1}

### Bug Fixes

- Fix - Searching for specific version on v3 only feed returns no results - see [#3396](https://github.com/chocolatey/choco/issues/3396).
- Fix - Credentials from configured source used for a non-configured source when the URL is similar - see [#3565](https://github.com/chocolatey/choco/issues/3565).

## 1.4.1 (Dec 4, 2024) \{#v1.4.1}

### Bug Fix

- Fix - Credentials from configured source used for a non-configured source when the URL is similar - see [#3566](https://github.com/chocolatey/choco/issues/3566).

## 2.4.0 (Nov 12, 2024) \{#v2.4.0}

### Deprecated Feature

- Deprecate the `Install-ChocolateyPinnedTaskBarItem` helper function - see [#3520](https://github.com/chocolatey/choco/issues/3520).

### Bug Fixes

- Fix - Update tab completions for compatibility with PowerShell 7.4+ - see [#3364](https://github.com/chocolatey/choco/issues/3364).
- Fix - Prevent dependency resolution from unexpectedly downgrading packages - see [#3461](https://github.com/chocolatey/choco/issues/3461).
- Fix - Do not install packages if dependencies fail to install - see [#3487](https://github.com/chocolatey/choco/issues/3487).
- Fix - Ensure package folders are correctly restored if unexpected failures occur during upgrade - see [#3489](https://github.com/chocolatey/choco/issues/3489).
- Fix - Use the user-provided page size when querying repositories - see [#3502](https://github.com/chocolatey/choco/issues/3502).
- Fix - Ensure `.arguments` files that cannot be decrypted do not prevent running Chocolatey CLI commands - see [#3503](https://github.com/chocolatey/choco/issues/3503).
- Fix - Ensure invalid `.arguments` files do not prevent running Chocolatey CLI commands - see [#3513](https://github.com/chocolatey/choco/issues/3513).

### Improvements

- Rework build process to remove the use of `-unpackself` command - see [#3427](https://github.com/chocolatey/choco/issues/3427).
- Dependency resolution during install can be slow - see [#3451](https://github.com/chocolatey/choco/issues/3451).
- Remove historical folder migration logic from `chocolateysetup.psm1` - see [#3501](https://github.com/chocolatey/choco/issues/3501).
- Updated the bundled version of 7zip to 24.08 - see [#3505](https://github.com/chocolatey/choco/issues/3505).
- Provide better information through the user agent when querying remote repositories - see [#3526](https://github.com/chocolatey/choco/issues/3526).

### Documentation

- Update build instructions - see [#3467](https://github.com/chocolatey/choco/pull/3467).
- Fixed parameter name typo in the chocolateyInstall template - see [#3504](https://github.com/chocolatey/choco/pull/3504).


## 2.3.0 (June 5, 2024) \{#v2.3.0}

### Deprecated Feature
Expand Down Expand Up @@ -70,6 +113,7 @@ This covers changes for the "chocolatey" and "chocolatey.lib" packages, which ar
- Clarify `Proxy BypassList` value must be a regular expression, in the help output - see [#3401](https://github.com/chocolatey/choco/issues/3401).
- Remove reference of unused `zip.sh` from README.md file - see [#3402](https://github.com/chocolatey/choco/pull/3402).


## 2.2.2 (August 8, 2023) \{#august-8-2023}

<Callout type="warning">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,16 @@ import PackageValidatorRuleNote from '@components/docs/PackageValidatorRuleNote.

<PackageValidatorRuleNote />

<Callout type="info">
This page is a stub that has not yet been filled out. If you have questions about this issue, please ask in the review or reach out on [Community Chat](https://ch0.co/community)
</Callout>

## Issue

In the nuspec,
In the nuspec, the tag `notSilent` has been specified, indicating that the package is not silent, which means that there is some indication that an install, upgrade or uninstall is taking place such as a window being shown, a progress bar or something else that is visible.

A package not specifying this tag indicates it is entirely silent in all scenarios that are known.

## Recommended Solution

Please update _ so that _
If the installation, upgrade or uninstall of the package is silent, please update the nuspec to not contain the `notSilent` tag, which means there is some indication that an install, upgrade or uninstall is taking place such as a window being shown, a progress bar or something else that is visible.

## Reasoning

The tag `notSilent` should only be used to indicate that the package is not silent.
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,16 @@ import PackageValidatorRuleNote from '@components/docs/PackageValidatorRuleNote.

<PackageValidatorRuleNote />

<Callout type="info">
This page is a stub that has not yet been filled out. If you have questions about this issue, please ask in the review or reach out on [Community Chat](https://ch0.co/community)
</Callout>

## Issue

In the nuspec,
In the nuspec, the Package Maintainers (`owners`) and Software Authors (`authors`) fields are the same names, indicating that the same people or organization are responsible for both the package, and the software.

## Recommended Solution

Please update _ so that _
If the Package Maintainers and Software Authors are not the same people / organization, please update the `owners` and / or the `authors` field to the correct names.
If the package is provided by the same peple or organization that provides the software, there is nothing that needs to be updated.

## Reasoning

Chocolatey packages are typically created and maintained by Chocolatey Community Members, rather than Software Authors.
Due to this, and to avoid the wrong metadata being published on the Chocolatey Community Repository, such packages are flagged at all times.
Loading

0 comments on commit 5dc00b5

Please sign in to comment.