diff --git a/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_correctness_opensslpasswordhelpers.yml b/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_correctness_opensslpasswordhelpers.yml index 01bbde7e60..f30c542e3a 100644 --- a/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_correctness_opensslpasswordhelpers.yml +++ b/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_correctness_opensslpasswordhelpers.yml @@ -10,7 +10,7 @@ description: |- basic_auth_password = secure_password autocorrection: false target_chef_version: All Versions -examples: +examples: version_added: 6.6.0 enabled: true excluded_file_paths: diff --git a/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_deprecations_cheffile.yml b/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_deprecations_cheffile.yml index 9fd44cf2b0..4cc440d474 100644 --- a/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_deprecations_cheffile.yml +++ b/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_deprecations_cheffile.yml @@ -8,7 +8,7 @@ description: The Librarian-Chef depsolving project is no longer maintained and a offers a more similar, and still supported, experience to Librarian-Chef. autocorrection: false target_chef_version: All Versions -examples: +examples: version_added: 5.12.0 enabled: true included_file_paths: diff --git a/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_deprecations_delivery.yml b/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_deprecations_delivery.yml index 84c0b75d73..ab7a22740a 100644 --- a/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_deprecations_delivery.yml +++ b/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_deprecations_delivery.yml @@ -9,7 +9,7 @@ description: |- or Delivery cookbooks. The contents of this directory are now obsolete and should be removed. autocorrection: false target_chef_version: All Versions -examples: +examples: version_added: 7.31.0 enabled: true included_file_paths: diff --git a/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_deprecations_foodcriticfile.yml b/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_deprecations_foodcriticfile.yml index 7dfbf83d9e..1669dc1715 100644 --- a/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_deprecations_foodcriticfile.yml +++ b/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_deprecations_foodcriticfile.yml @@ -7,7 +7,7 @@ description: The Foodcritic cookbook linter has been deprecated and should no lo by Foodcritic in your cookbooks. autocorrection: false target_chef_version: All Versions -examples: +examples: version_added: 7.32.0 enabled: true included_file_paths: diff --git a/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_deprecations_searchusespositionalparameters.yml b/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_deprecations_searchusespositionalparameters.yml index f5fb6f09e0..a6483b1661 100644 --- a/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_deprecations_searchusespositionalparameters.yml +++ b/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_deprecations_searchusespositionalparameters.yml @@ -11,7 +11,7 @@ description: |- search(:node, '*:*', start: 0) autocorrection: true target_chef_version: All Versions -examples: +examples: version_added: 5.11.0 enabled: true excluded_file_paths: diff --git a/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_effortless_berksfile.yml b/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_effortless_berksfile.yml index b154c95fd6..548e1b595b 100644 --- a/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_effortless_berksfile.yml +++ b/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_effortless_berksfile.yml @@ -6,7 +6,7 @@ description: Policyfiles should be used for cookbook dependency solving instead a Berkshelf Berksfile. autocorrection: false target_chef_version: All Versions -examples: +examples: version_added: 5.12.0 enabled: false included_file_paths: diff --git a/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_modernize_definitions.yml b/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_modernize_definitions.yml index 2a76d7e225..b48a80d496 100644 --- a/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_modernize_definitions.yml +++ b/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_modernize_definitions.yml @@ -9,7 +9,7 @@ description: In 2016 with Chef Infra Client 12.5 Custom Resources were introduce resource reporting. autocorrection: false target_chef_version: All Versions -examples: +examples: version_added: 5.11.0 enabled: true included_file_paths: diff --git a/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_redundantcode_sensitivepropertyinresource.yml b/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_redundantcode_sensitivepropertyinresource.yml index 8303c7919a..b61f14aa86 100644 --- a/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_redundantcode_sensitivepropertyinresource.yml +++ b/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_redundantcode_sensitivepropertyinresource.yml @@ -9,7 +9,7 @@ description: |- property :sensitive, [true, false], default: false autocorrection: true target_chef_version: All Versions -examples: +examples: version_added: 5.16.0 enabled: true included_file_paths: diff --git a/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_ruby_gemspeclicense.yml b/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_ruby_gemspeclicense.yml new file mode 100644 index 0000000000..413de2683f --- /dev/null +++ b/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_ruby_gemspeclicense.yml @@ -0,0 +1,14 @@ +--- +short_name: GemspecLicense +full_name: Chef/Ruby/GemspecLicense +department: Chef/Ruby +description: All gemspec files should define their license. +autocorrection: false +target_chef_version: All Versions +examples: |2- + + # good + spec.license = "Apache-2.0" + ``` +version_added: +enabled: false diff --git a/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_ruby_gemspecrequirerubygems.yml b/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_ruby_gemspecrequirerubygems.yml new file mode 100644 index 0000000000..02a65dfa91 --- /dev/null +++ b/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_ruby_gemspecrequirerubygems.yml @@ -0,0 +1,11 @@ +--- +short_name: GemspecRequireRubygems +full_name: Chef/Ruby/GemspecRequireRubygems +department: Chef/Ruby +description: Rubygems does not need to be required in a Gemspec. It's already loaded + out of the box in Ruby now. +autocorrection: true +target_chef_version: All Versions +examples: +version_added: +enabled: false diff --git a/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_ruby_legacypowershelloutmethods.yml b/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_ruby_legacypowershelloutmethods.yml new file mode 100644 index 0000000000..5670632813 --- /dev/null +++ b/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_ruby_legacypowershelloutmethods.yml @@ -0,0 +1,12 @@ +--- +short_name: LegacyPowershellOutMethods +full_name: Chef/Ruby/LegacyPowershellOutMethods +department: Chef/Ruby +description: |- + 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. +autocorrection: false +target_chef_version: All Versions +examples: +version_added: +enabled: false diff --git a/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_ruby_requirenethttps.yml b/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_ruby_requirenethttps.yml new file mode 100644 index 0000000000..41238c40d2 --- /dev/null +++ b/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_ruby_requirenethttps.yml @@ -0,0 +1,19 @@ +--- +short_name: RequireNetHttps +full_name: Chef/Ruby/RequireNetHttps +department: Chef/Ruby +description: net/https is deprecated and just includes net/http and openssl. We should + include those directly instead. +autocorrection: true +target_chef_version: All Versions +examples: |2- + + # bad + require 'net/https' + + # good + require 'net/http' + require 'openssl' + ``` +version_added: +enabled: false diff --git a/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_ruby_unlessdefinedrequire.yml b/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_ruby_unlessdefinedrequire.yml new file mode 100644 index 0000000000..a0427721b7 --- /dev/null +++ b/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_ruby_unlessdefinedrequire.yml @@ -0,0 +1,12 @@ +--- +short_name: UnlessDefinedRequire +full_name: Chef/Ruby/UnlessDefinedRequire +department: Chef/Ruby +description: |- + 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. +autocorrection: true +target_chef_version: All Versions +examples: +version_added: +enabled: false diff --git a/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_style_commentsentencespacing.yml b/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_style_commentsentencespacing.yml index 9b7d6b1bb1..8c24516237 100644 --- a/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_style_commentsentencespacing.yml +++ b/generated/_vendor/github.com/chef/cookstyle/docs-chef-io/assets/cookstyle/cops_chef_style_commentsentencespacing.yml @@ -7,6 +7,6 @@ description: |- Note: This is DISABLED by default. autocorrection: true target_chef_version: All Versions -examples: +examples: version_added: 5.1.0 enabled: false diff --git a/generated/_vendor/modules.txt b/generated/_vendor/modules.txt index f724d229ca..9c287e2587 100644 --- a/generated/_vendor/modules.txt +++ b/generated/_vendor/modules.txt @@ -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 diff --git a/generated/generated_content/workstation/cookstyle/cops/_index.md b/generated/generated_content/workstation/cookstyle/cops/_index.md index 7d503fea54..0b69f9aa40 100644 --- a/generated/generated_content/workstation/cookstyle/cops/_index.md +++ b/generated/generated_content/workstation/cookstyle/cops/_index.md @@ -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 + + + +- [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. diff --git a/generated/generated_content/workstation/cookstyle/cops/chef_ruby_gemspeclicense.md b/generated/generated_content/workstation/cookstyle/cops/chef_ruby_gemspeclicense.md new file mode 100644 index 0000000000..edc57bea87 --- /dev/null +++ b/generated/generated_content/workstation/cookstyle/cops/chef_ruby_gemspeclicense.md @@ -0,0 +1,43 @@ ++++ +title = "Chef/Ruby/GemspecLicense" +aliases = ["/workstation/cookstyle/chef_ruby_gemspeclicense/"] + ++++ + + + +[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 + + + + + + + + + + + + + + + +
NameDefault valueConfigurable values
Version AddedString
Include
    +
+		Array
diff --git a/generated/generated_content/workstation/cookstyle/cops/chef_ruby_gemspecrequirerubygems.md b/generated/generated_content/workstation/cookstyle/cops/chef_ruby_gemspecrequirerubygems.md new file mode 100644 index 0000000000..595b70d1e3 --- /dev/null +++ b/generated/generated_content/workstation/cookstyle/cops/chef_ruby_gemspecrequirerubygems.md @@ -0,0 +1,40 @@ ++++ +title = "Chef/Ruby/GemspecRequireRubygems" +aliases = ["/workstation/cookstyle/chef_ruby_gemspecrequirerubygems/"] + ++++ + + + +[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 + + +## Configurable attributes + + + + + + + + + + + + + + + +
NameDefault valueConfigurable values
Version AddedString
Include
    +
+		Array
diff --git a/generated/generated_content/workstation/cookstyle/cops/chef_ruby_legacypowershelloutmethods.md b/generated/generated_content/workstation/cookstyle/cops/chef_ruby_legacypowershelloutmethods.md new file mode 100644 index 0000000000..d5007611fe --- /dev/null +++ b/generated/generated_content/workstation/cookstyle/cops/chef_ruby_legacypowershelloutmethods.md @@ -0,0 +1,41 @@ ++++ +title = "Chef/Ruby/LegacyPowershellOutMethods" +aliases = ["/workstation/cookstyle/chef_ruby_legacypowershelloutmethods/"] + ++++ + + + +[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 + + +## Configurable attributes + + + + + + + + + + + + + + + +
NameDefault valueConfigurable values
Version AddedString
Include
    +
+		Array
diff --git a/generated/generated_content/workstation/cookstyle/cops/chef_ruby_requirenethttps.md b/generated/generated_content/workstation/cookstyle/cops/chef_ruby_requirenethttps.md new file mode 100644 index 0000000000..9e03dd6545 --- /dev/null +++ b/generated/generated_content/workstation/cookstyle/cops/chef_ruby_requirenethttps.md @@ -0,0 +1,47 @@ ++++ +title = "Chef/Ruby/RequireNetHttps" +aliases = ["/workstation/cookstyle/chef_ruby_requirenethttps/"] + ++++ + + + +[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 + + + + + + + + + + + + + + + +
NameDefault valueConfigurable values
Version AddedString
Include
    +
+		Array
diff --git a/generated/generated_content/workstation/cookstyle/cops/chef_ruby_unlessdefinedrequire.md b/generated/generated_content/workstation/cookstyle/cops/chef_ruby_unlessdefinedrequire.md new file mode 100644 index 0000000000..9f51d85b76 --- /dev/null +++ b/generated/generated_content/workstation/cookstyle/cops/chef_ruby_unlessdefinedrequire.md @@ -0,0 +1,41 @@ ++++ +title = "Chef/Ruby/UnlessDefinedRequire" +aliases = ["/workstation/cookstyle/chef_ruby_unlessdefinedrequire/"] + ++++ + + + +[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 + + +## Configurable attributes + + + + + + + + + + + + + + + +
NameDefault valueConfigurable values
Version AddedString
Include
    +
+		Array
diff --git a/generated/go.mod b/generated/go.mod index ace29d8f3b..7602f6434f 100644 --- a/generated/go.mod +++ b/generated/go.mod @@ -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 ) diff --git a/generated/go.sum b/generated/go.sum index 1fe377ebed..d5655f098b 100644 --- a/generated/go.sum +++ b/generated/go.sum @@ -1,4 +1,4 @@ -github.com/chef/cookstyle v7.32.3+incompatible h1:7ZJ3ZdAOAnElLm2nI3FycomDGAZLXXghCX2AsFpd6s8= -github.com/chef/cookstyle v7.32.3+incompatible/go.mod h1:KUadmsdBr7Hpo5dtGVQMiwb8KlC91W3j1lfc0yuVwtw= -github.com/chef/cookstyle/docs-chef-io v0.0.0-20230825054940-2971520aef80 h1:qR1b+TF26odPlERq2C75CrFcIFmJ9TJCjGEs2fUT/0c= -github.com/chef/cookstyle/docs-chef-io v0.0.0-20230825054940-2971520aef80/go.mod h1:1JOEECsW9ozt1/RmprJjAQEvCrOHobpWepSQJRQOhnY= +github.com/chef/cookstyle v7.32.8+incompatible h1:/TRU03BE6XMorXedRW4kg9/kKc+OnarTvGMhc+9COvU= +github.com/chef/cookstyle v7.32.8+incompatible/go.mod h1:KUadmsdBr7Hpo5dtGVQMiwb8KlC91W3j1lfc0yuVwtw= +github.com/chef/cookstyle/docs-chef-io v0.0.0-20240206215225-64410f1feded h1:BVbNH4t77v237/8B94pu+Pfp4DlPMm7zwNYF6bsfdXY= +github.com/chef/cookstyle/docs-chef-io v0.0.0-20240206215225-64410f1feded/go.mod h1:1JOEECsW9ozt1/RmprJjAQEvCrOHobpWepSQJRQOhnY=