-
Notifications
You must be signed in to change notification settings - Fork 436
Commit
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. Co-authored-by: Chef Expeditor <[email protected]>
- Loading branch information
There are no files selected for viewing
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.
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-20240123213114-ace8dd00994a |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
+++ | ||
title = "Chef/Ruby/GemspecLicense" | ||
aliases = ["/workstation/cookstyle/chef_ruby_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/"] | ||
|
||
+++ | ||
|
||
<!-- 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/"] | ||
|
||
+++ | ||
|
||
<!-- 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/"] | ||
|
||
+++ | ||
|
||
<!-- 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> |