Skip to content

Commit

Permalink
Bump Hugo module chef/cookstyle:main to latest stable.
Browse files Browse the repository at this point in the history
This pull request was triggered automatically via Expeditor.

This change falls under the obvious fix policy so no Developer Certificate of Origin (DCO) sign-off is required.
  • Loading branch information
chef-ci committed Feb 6, 2024
1 parent ebbb17d commit a92e8ee
Show file tree
Hide file tree
Showing 23 changed files with 306 additions and 16 deletions.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion generated/_vendor/modules.txt
Original file line number Diff line number Diff line change
@@ -1 +1 @@
# github.com/chef/cookstyle/docs-chef-io v0.0.0-20230825054940-2971520aef80
# github.com/chef/cookstyle/docs-chef-io v0.0.0-20240206215225-64410f1feded
10 changes: 10 additions & 0 deletions generated/generated_content/workstation/cookstyle/cops/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -264,6 +264,16 @@ These cops detect redundant cookbook code.
- [UnnecessaryNameProperty](/workstation/cookstyle/cops/chef_redundantcode_unnecessarynameproperty)
- [UseCreateIfMissing](/workstation/cookstyle/cops/chef_redundantcode_usecreateifmissing)

## Chef/Ruby

<nil>

- [GemspecLicense](/workstation/cookstyle/cops/chef_ruby_gemspeclicense)
- [GemspecRequireRubygems](/workstation/cookstyle/cops/chef_ruby_gemspecrequirerubygems)
- [LegacyPowershellOutMethods](/workstation/cookstyle/cops/chef_ruby_legacypowershelloutmethods)
- [RequireNetHttps](/workstation/cookstyle/cops/chef_ruby_requirenethttps)
- [UnlessDefinedRequire](/workstation/cookstyle/cops/chef_ruby_unlessdefinedrequire)

## Chef/Security

These cops detect potential security issues in your cookbook code.
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
+++
title = "Chef/Ruby/GemspecLicense"
aliases = ["/workstation/cookstyle/chef_ruby_gemspeclicense/"]

Check failure on line 3 in generated/generated_content/workstation/cookstyle/cops/chef_ruby_gemspeclicense.md

View workflow job for this annotation

GitHub Actions / cspell-action

Unknown word (gemspeclicense)

+++

<!-- This content is automatically generated. See https://github.com/chef/chef-web-docs/blob/main/generated/README.md -->

[Cookstyle cops page](/workstation/cookstyle/cops/)

The Cookstyle cops department: `Chef/Ruby`

| Enabled by default | Supports autocorrection | Target Chef Version |
| --- | --- | --- |
| Not Enabled | No | All Versions |

All gemspec files should define their license.

## Examples

# good
spec.license = "Apache-2.0"
```
## Configurable attributes
<table>
<tbody><tr>
<th>Name</th>
<th>Default value</th>
<th>Configurable values</th>
</tr>
<tr>
<td style="text-align:center">Version Added</td>
<td style="text-align:center"><nil></td>
<td style="text-align:center">String</td>
</tr>
<tr><td style="text-align:center">Include</td>
<td style="text-align:center"><ul>
</ul>
</td>
<td style="text-align:center">Array</td>
</tr></tbody></table>
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
+++
title = "Chef/Ruby/GemspecRequireRubygems"
aliases = ["/workstation/cookstyle/chef_ruby_gemspecrequirerubygems/"]

Check failure on line 3 in generated/generated_content/workstation/cookstyle/cops/chef_ruby_gemspecrequirerubygems.md

View workflow job for this annotation

GitHub Actions / cspell-action

Unknown word (gemspecrequirerubygems)

+++

<!-- This content is automatically generated. See https://github.com/chef/chef-web-docs/blob/main/generated/README.md -->

[Cookstyle cops page](/workstation/cookstyle/cops/)

The Cookstyle cops department: `Chef/Ruby`

| Enabled by default | Supports autocorrection | Target Chef Version |
| --- | --- | --- |
| Not Enabled | Yes | All Versions |

Rubygems does not need to be required in a Gemspec. It's already loaded out of the box in Ruby now.

## Examples
<nil>

## Configurable attributes

<table>
<tbody><tr>
<th>Name</th>
<th>Default value</th>
<th>Configurable values</th>
</tr>
<tr>
<td style="text-align:center">Version Added</td>
<td style="text-align:center"><nil></td>
<td style="text-align:center">String</td>
</tr>
<tr><td style="text-align:center">Include</td>
<td style="text-align:center"><ul>
</ul>
</td>
<td style="text-align:center">Array</td>
</tr></tbody></table>
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
+++
title = "Chef/Ruby/LegacyPowershellOutMethods"
aliases = ["/workstation/cookstyle/chef_ruby_legacypowershelloutmethods/"]

Check failure on line 3 in generated/generated_content/workstation/cookstyle/cops/chef_ruby_legacypowershelloutmethods.md

View workflow job for this annotation

GitHub Actions / cspell-action

Unknown word (legacypowershelloutmethods)

+++

<!-- This content is automatically generated. See https://github.com/chef/chef-web-docs/blob/main/generated/README.md -->

[Cookstyle cops page](/workstation/cookstyle/cops/)

The Cookstyle cops department: `Chef/Ruby`

| Enabled by default | Supports autocorrection | Target Chef Version |
| --- | --- | --- |
| Not Enabled | No | All Versions |

Use powershell_exec!/powershell_exec instead of powershell_out!/powershell_out. The new
methods don't spawn 2 shells per shellout and instead use .NET bindings to call PS directly.

## Examples
<nil>

## Configurable attributes

<table>
<tbody><tr>
<th>Name</th>
<th>Default value</th>
<th>Configurable values</th>
</tr>
<tr>
<td style="text-align:center">Version Added</td>
<td style="text-align:center"><nil></td>
<td style="text-align:center">String</td>
</tr>
<tr><td style="text-align:center">Include</td>
<td style="text-align:center"><ul>
</ul>
</td>
<td style="text-align:center">Array</td>
</tr></tbody></table>
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
+++
title = "Chef/Ruby/RequireNetHttps"
aliases = ["/workstation/cookstyle/chef_ruby_requirenethttps/"]

Check failure on line 3 in generated/generated_content/workstation/cookstyle/cops/chef_ruby_requirenethttps.md

View workflow job for this annotation

GitHub Actions / cspell-action

Unknown word (requirenethttps)

+++

<!-- This content is automatically generated. See https://github.com/chef/chef-web-docs/blob/main/generated/README.md -->

[Cookstyle cops page](/workstation/cookstyle/cops/)

The Cookstyle cops department: `Chef/Ruby`

| Enabled by default | Supports autocorrection | Target Chef Version |
| --- | --- | --- |
| Not Enabled | Yes | All Versions |

net/https is deprecated and just includes net/http and openssl. We should include those directly instead.

## Examples

# bad
require 'net/https'

# good
require 'net/http'
require 'openssl'
```
## Configurable attributes
<table>
<tbody><tr>
<th>Name</th>
<th>Default value</th>
<th>Configurable values</th>
</tr>
<tr>
<td style="text-align:center">Version Added</td>
<td style="text-align:center"><nil></td>
<td style="text-align:center">String</td>
</tr>
<tr><td style="text-align:center">Include</td>
<td style="text-align:center"><ul>
</ul>
</td>
<td style="text-align:center">Array</td>
</tr></tbody></table>
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
+++
title = "Chef/Ruby/UnlessDefinedRequire"
aliases = ["/workstation/cookstyle/chef_ruby_unlessdefinedrequire/"]

+++

<!-- This content is automatically generated. See https://github.com/chef/chef-web-docs/blob/main/generated/README.md -->

[Cookstyle cops page](/workstation/cookstyle/cops/)

The Cookstyle cops department: `Chef/Ruby`

| Enabled by default | Supports autocorrection | Target Chef Version |
| --- | --- | --- |
| Not Enabled | Yes | All Versions |

Rubygems is VERY slow to require gems even if they've already been loaded. To work around this
wrap your require statement with an `if defined?()` check.

## Examples
<nil>

## Configurable attributes

<table>
<tbody><tr>
<th>Name</th>
<th>Default value</th>
<th>Configurable values</th>
</tr>
<tr>
<td style="text-align:center">Version Added</td>
<td style="text-align:center"><nil></td>
<td style="text-align:center">String</td>
</tr>
<tr><td style="text-align:center">Include</td>
<td style="text-align:center"><ul>
</ul>
</td>
<td style="text-align:center">Array</td>
</tr></tbody></table>
4 changes: 2 additions & 2 deletions generated/go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@ module github.com/chef/chef-web-docs/generated
go 1.17

require (
github.com/chef/cookstyle v7.32.3+incompatible // indirect
github.com/chef/cookstyle/docs-chef-io v0.0.0-20230825054940-2971520aef80 // indirect
github.com/chef/cookstyle v7.32.8+incompatible // indirect
github.com/chef/cookstyle/docs-chef-io v0.0.0-20240206215225-64410f1feded // indirect
)
Loading

0 comments on commit a92e8ee

Please sign in to comment.