Merge pull request #674 from dothomson/docs-update

ericzbeard · web-flow · commit ea4eb8707d10 · 2025-04-07T12:57:12.000-07:00
Update docs - strict-booleans and default branch name
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -23,7 +23,7 @@ reported the issue. Please try to include as much information as you can. Detail
 ## Contributing via Pull Requests
 Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:
 
-1. You are working against the latest source on the *master* branch.
+1. You are working against the latest source on the *main* branch.
 2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
 3. You open an issue to discuss any significant work - we would hate for your time to be wasted.
 
@@ -56,6 +56,6 @@ If you discover a potential security issue in this project we ask that you notif
 
 ## Licensing
 
-See the [LICENSE](https://github.com/aws-cloudformation/rain/blob/master/LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution.
+See the [LICENSE](https://github.com/aws-cloudformation/rain/blob/main/LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution.
 
 We may ask you to sign a [Contributor License Agreement (CLA)](http://en.wikipedia.org/wiki/Contributor_License_Agreement) for larger changes.
diff --git a/cft/format/transform.go b/cft/format/transform.go
@@ -11,7 +11,7 @@ import (
 // Global, set by command arg --node-style
 var NodeStyle string
 
-var NodeStyleDocs = "Set the node output style to tagged, doublequoted, singlequoted, literal, folded, quotescalars, original, or flow"
+var NodeStyleDocs = "Set the node output style to tagged, doublequoted, singlequoted, literal, folded, strict-boolean, quotescalars, original, or flow"
 
 func mergeComments(comments []string) string {
 	out := strings.Builder{}
diff --git a/docs/index.md b/docs/index.md
@@ -36,4 +36,4 @@ Rain is a command line tool for working with AWS CloudFormation templates and st
 * [rain tree](rain_tree.md)	 - Find dependencies of Resources and Outputs in a local template
 * [rain watch](rain_watch.md)	 - Display an updating view of a CloudFormation stack
 
-###### Auto generated by spf13/cobra on 3-Apr-2025
+###### Auto generated by spf13/cobra on 7-Apr-2025
diff --git a/docs/rain_bootstrap.md b/docs/rain_bootstrap.md
@@ -33,4 +33,4 @@ rain bootstrap
 
 * [rain](index.md)	 - 
 
-###### Auto generated by spf13/cobra on 3-Apr-2025
+###### Auto generated by spf13/cobra on 7-Apr-2025
diff --git a/docs/rain_build.md b/docs/rain_build.md
@@ -42,4 +42,4 @@ rain build [<resource type>] or <prompt>
 
 * [rain](index.md)	 - 
 
-###### Auto generated by spf13/cobra on 3-Apr-2025
+###### Auto generated by spf13/cobra on 7-Apr-2025
diff --git a/docs/rain_cat.md b/docs/rain_cat.md
@@ -35,4 +35,4 @@ rain cat <stack>
 
 * [rain](index.md)	 - 
 
-###### Auto generated by spf13/cobra on 3-Apr-2025
+###### Auto generated by spf13/cobra on 7-Apr-2025
diff --git a/docs/rain_cc.md b/docs/rain_cc.md
@@ -33,4 +33,4 @@ You must pass the --experimental (-x) flag to use this command, to acknowledge t
 * [rain cc rm](rain_cc_rm.md)	 - Delete a deployment created by cc deploy (Experimental!)
 * [rain cc state](rain_cc_state.md)	 - Download the state file for a template deployed with cc deploy
 
-###### Auto generated by spf13/cobra on 3-Apr-2025
+###### Auto generated by spf13/cobra on 7-Apr-2025
diff --git a/docs/rain_cc_deploy.md b/docs/rain_cc_deploy.md
@@ -40,4 +40,4 @@ rain cc deploy <template> <name>
 
 * [rain cc](rain_cc.md)	 - Interact with templates using Cloud Control API instead of CloudFormation
 
-###### Auto generated by spf13/cobra on 3-Apr-2025
+###### Auto generated by spf13/cobra on 7-Apr-2025
diff --git a/docs/rain_cc_drift.md b/docs/rain_cc_drift.md
@@ -33,4 +33,4 @@ rain cc drift <name>
 
 * [rain cc](rain_cc.md)	 - Interact with templates using Cloud Control API instead of CloudFormation
 
-###### Auto generated by spf13/cobra on 3-Apr-2025
+###### Auto generated by spf13/cobra on 7-Apr-2025
diff --git a/docs/rain_cc_rm.md b/docs/rain_cc_rm.md
@@ -33,4 +33,4 @@ rain cc rm <name>
 
 * [rain cc](rain_cc.md)	 - Interact with templates using Cloud Control API instead of CloudFormation
 
-###### Auto generated by spf13/cobra on 3-Apr-2025
+###### Auto generated by spf13/cobra on 7-Apr-2025
diff --git a/docs/rain_cc_state.md b/docs/rain_cc_state.md
@@ -33,4 +33,4 @@ rain cc state <name>
 
 * [rain cc](rain_cc.md)	 - Interact with templates using Cloud Control API instead of CloudFormation
 
-###### Auto generated by spf13/cobra on 3-Apr-2025
+###### Auto generated by spf13/cobra on 7-Apr-2025
diff --git a/docs/rain_console.md b/docs/rain_console.md
@@ -39,4 +39,4 @@ rain console [stack]
 
 * [rain](index.md)	 - 
 
-###### Auto generated by spf13/cobra on 3-Apr-2025
+###### Auto generated by spf13/cobra on 7-Apr-2025
diff --git a/docs/rain_deploy.md b/docs/rain_deploy.md
@@ -64,7 +64,7 @@ rain deploy <template> [stack]
       --nested-change-set        Whether or not to include nested stacks in the change set (default true)
       --no-analytics             Do not write analytics to Metadata
   -x, --no-exec                  do not execute the changeset
-      --node-style string        Set the node output style to tagged, doublequoted, singlequoted, literal, folded, quotescalars, original, or flow (default "original")
+      --node-style string        Set the node output style to tagged, doublequoted, singlequoted, literal, folded, strict-boolean, quotescalars, original, or flow (default "original")
       --params strings           set parameter values; use the format key1=value1,key2=value2
   -p, --profile string           AWS profile name; read from the AWS CLI configuration file
   -r, --region string            AWS region to use
@@ -88,4 +88,4 @@ rain deploy <template> [stack]
 
 * [rain](index.md)	 - 
 
-###### Auto generated by spf13/cobra on 3-Apr-2025
+###### Auto generated by spf13/cobra on 7-Apr-2025
diff --git a/docs/rain_diff.md b/docs/rain_diff.md
@@ -28,4 +28,4 @@ rain diff <from> <to>
 
 * [rain](index.md)	 - 
 
-###### Auto generated by spf13/cobra on 3-Apr-2025
+###### Auto generated by spf13/cobra on 7-Apr-2025
diff --git a/docs/rain_fmt.md b/docs/rain_fmt.md
@@ -17,7 +17,7 @@ rain fmt <filename>...
       --debug                Output debugging information
   -h, --help                 help for fmt
   -j, --json                 Output the template as JSON (default format: YAML).
-      --node-style string    Set the node output style to tagged, doublequoted, singlequoted, literal, folded, quotescalars, original, or flow
+      --node-style string    Set the node output style to tagged, doublequoted, singlequoted, literal, folded, strict-boolean, quotescalars, original, or flow
   -p, --pkl                  Output the template as Pkl (default format: YAML).
       --pkl-basic            Don't use Pkl modules for output
       --pkl-package string   An alias or full package URI for the Pkl package for generated Pkl files (default "@cfn")
@@ -38,4 +38,4 @@ rain fmt <filename>...
 
 * [rain](index.md)	 - 
 
-###### Auto generated by spf13/cobra on 3-Apr-2025
+###### Auto generated by spf13/cobra on 7-Apr-2025
diff --git a/docs/rain_forecast.md b/docs/rain_forecast.md
@@ -55,4 +55,4 @@ rain forecast --experimental <template> [stackName]
 
 * [rain](index.md)	 - 
 
-###### Auto generated by spf13/cobra on 3-Apr-2025
+###### Auto generated by spf13/cobra on 7-Apr-2025
diff --git a/docs/rain_info.md b/docs/rain_info.md
@@ -30,4 +30,4 @@ rain info
 
 * [rain](index.md)	 - 
 
-###### Auto generated by spf13/cobra on 3-Apr-2025
+###### Auto generated by spf13/cobra on 7-Apr-2025
diff --git a/docs/rain_logs.md b/docs/rain_logs.md
@@ -37,4 +37,4 @@ rain logs <stack> (<resource>)
 
 * [rain](index.md)	 - 
 
-###### Auto generated by spf13/cobra on 3-Apr-2025
+###### Auto generated by spf13/cobra on 7-Apr-2025
diff --git a/docs/rain_ls.md b/docs/rain_ls.md
@@ -31,4 +31,4 @@ rain ls <stack> [changeset]
 
 * [rain](index.md)	 - 
 
-###### Auto generated by spf13/cobra on 3-Apr-2025
+###### Auto generated by spf13/cobra on 7-Apr-2025
diff --git a/docs/rain_merge.md b/docs/rain_merge.md
@@ -16,7 +16,7 @@ rain merge <template> <template> ...
   -f, --force               Don't warn on clashing attributes; rename them instead. Note: this will not rename Refs, GetAtts, etc.
   -h, --help                help for merge
       --merge-imports       Convert imported output values into GetAtts
-      --node-style string   Set the node output style to tagged, doublequoted, singlequoted, literal, folded, quotescalars, original, or flow
+      --node-style string   Set the node output style to tagged, doublequoted, singlequoted, literal, folded, strict-boolean, quotescalars, original, or flow
   -o, --output string       Output merged template to a file
 ```
 
@@ -31,4 +31,4 @@ rain merge <template> <template> ...
 
 * [rain](index.md)	 - 
 
-###### Auto generated by spf13/cobra on 3-Apr-2025
+###### Auto generated by spf13/cobra on 7-Apr-2025
diff --git a/docs/rain_module.md b/docs/rain_module.md
@@ -31,4 +31,4 @@ The rain module command can be used to publish modules to CodeArtifact, and to i
 * [rain module install](rain_module_install.md)	 - Install a package of Rain modules from CodeArtifact
 * [rain module publish](rain_module_publish.md)	 - Publish a directory of Rain modules to CodeArtifact
 
-###### Auto generated by spf13/cobra on 3-Apr-2025
+###### Auto generated by spf13/cobra on 7-Apr-2025
diff --git a/docs/rain_module_bootstrap.md b/docs/rain_module_bootstrap.md
@@ -29,4 +29,4 @@ rain module bootstrap [flags]
 
 * [rain module](rain_module.md)	 - Interact with Rain modules in CodeArtifact
 
-###### Auto generated by spf13/cobra on 3-Apr-2025
+###### Auto generated by spf13/cobra on 7-Apr-2025
diff --git a/docs/rain_module_install.md b/docs/rain_module_install.md
@@ -30,4 +30,4 @@ rain module install <name> [flags]
 
 * [rain module](rain_module.md)	 - Interact with Rain modules in CodeArtifact
 
-###### Auto generated by spf13/cobra on 3-Apr-2025
+###### Auto generated by spf13/cobra on 7-Apr-2025
diff --git a/docs/rain_module_publish.md b/docs/rain_module_publish.md
@@ -30,4 +30,4 @@ rain module publish <name> [flags]
 
 * [rain module](rain_module.md)	 - Interact with Rain modules in CodeArtifact
 
-###### Auto generated by spf13/cobra on 3-Apr-2025
+###### Auto generated by spf13/cobra on 7-Apr-2025
diff --git a/docs/rain_pkg.md b/docs/rain_pkg.md
@@ -51,7 +51,7 @@ rain pkg <template>
   -x, --experimental        Enable experimental features
   -h, --help                help for pkg
       --no-analytics        Do not include analytics in Metadata
-      --node-style string   Set the node output style to tagged, doublequoted, singlequoted, literal, folded, quotescalars, original, or flow
+      --node-style string   Set the node output style to tagged, doublequoted, singlequoted, literal, folded, strict-boolean, quotescalars, original, or flow
   -o, --output string       Output packaged template to a file
   -p, --profile string      AWS profile name; read from the AWS CLI configuration file
   -r, --region string       AWS region to use
@@ -70,4 +70,4 @@ rain pkg <template>
 
 * [rain](index.md)	 - 
 
-###### Auto generated by spf13/cobra on 3-Apr-2025
+###### Auto generated by spf13/cobra on 7-Apr-2025
diff --git a/docs/rain_rm.md b/docs/rain_rm.md
@@ -34,4 +34,4 @@ rain rm <stack> [changeset]
 
 * [rain](index.md)	 - 
 
-###### Auto generated by spf13/cobra on 3-Apr-2025
+###### Auto generated by spf13/cobra on 7-Apr-2025
diff --git a/docs/rain_stackset.md b/docs/rain_stackset.md
@@ -28,4 +28,4 @@ This command manipulates stack sets. It has no action if specific stack set comm
 * [rain stackset ls](rain_stackset_ls.md)	 - List a CloudFormation stack sets in a given region
 * [rain stackset rm](rain_stackset_rm.md)	 - Delete a CloudFormation stack set and/or its instances.
 
-###### Auto generated by spf13/cobra on 3-Apr-2025
+###### Auto generated by spf13/cobra on 7-Apr-2025
diff --git a/docs/rain_stackset_deploy.md b/docs/rain_stackset_deploy.md
@@ -70,4 +70,4 @@ rain stackset deploy <template> [stackset] [flags]
 
 * [rain stackset](rain_stackset.md)	 - This command manipulates stack sets.
 
-###### Auto generated by spf13/cobra on 3-Apr-2025
+###### Auto generated by spf13/cobra on 7-Apr-2025
diff --git a/docs/rain_stackset_ls.md b/docs/rain_stackset_ls.md
@@ -31,4 +31,4 @@ rain stackset ls <stack set>
 
 * [rain stackset](rain_stackset.md)	 - This command manipulates stack sets.
 
-###### Auto generated by spf13/cobra on 3-Apr-2025
+###### Auto generated by spf13/cobra on 7-Apr-2025
diff --git a/docs/rain_stackset_rm.md b/docs/rain_stackset_rm.md
@@ -31,4 +31,4 @@ rain stackset rm <stackset>
 
 * [rain stackset](rain_stackset.md)	 - This command manipulates stack sets.
 
-###### Auto generated by spf13/cobra on 3-Apr-2025
+###### Auto generated by spf13/cobra on 7-Apr-2025
diff --git a/docs/rain_tree.md b/docs/rain_tree.md
@@ -30,4 +30,4 @@ rain tree [template]
 
 * [rain](index.md)	 - 
 
-###### Auto generated by spf13/cobra on 3-Apr-2025
+###### Auto generated by spf13/cobra on 7-Apr-2025
diff --git a/docs/rain_watch.md b/docs/rain_watch.md
@@ -30,4 +30,4 @@ rain watch <stack>
 
 * [rain](index.md)	 - 
 
-###### Auto generated by spf13/cobra on 3-Apr-2025
+###### Auto generated by spf13/cobra on 7-Apr-2025

Original file line number	Diff line number	Diff line change
`@@ -33,4 +33,4 @@ rain bootstrap`
`33`	`33`
`34`	`34`	`* [rain](index.md) -`
`35`	`35`
`36`		`-###### Auto generated by spf13/cobra on 3-Apr-2025`
	`36`	`+###### Auto generated by spf13/cobra on 7-Apr-2025`
Original file line number	Diff line number	Diff line change
`@@ -42,4 +42,4 @@ rain build [<resource type>] or <prompt>`
`42`	`42`
`43`	`43`	`* [rain](index.md) -`
`44`	`44`
`45`		`-###### Auto generated by spf13/cobra on 3-Apr-2025`
	`45`	`+###### Auto generated by spf13/cobra on 7-Apr-2025`
Original file line number	Diff line number	Diff line change
`@@ -35,4 +35,4 @@ rain cat <stack>`
`35`	`35`
`36`	`36`	`* [rain](index.md) -`
`37`	`37`
`38`		`-###### Auto generated by spf13/cobra on 3-Apr-2025`
	`38`	`+###### Auto generated by spf13/cobra on 7-Apr-2025`
Original file line number	Diff line number	Diff line change
`@@ -40,4 +40,4 @@ rain cc deploy <template> <name>`
`40`	`40`
`41`	`41`	`* [rain cc](rain_cc.md) - Interact with templates using Cloud Control API instead of CloudFormation`
`42`	`42`
`43`		`-###### Auto generated by spf13/cobra on 3-Apr-2025`
	`43`	`+###### Auto generated by spf13/cobra on 7-Apr-2025`
Original file line number	Diff line number	Diff line change
`@@ -33,4 +33,4 @@ rain cc drift <name>`
`33`	`33`
`34`	`34`	`* [rain cc](rain_cc.md) - Interact with templates using Cloud Control API instead of CloudFormation`
`35`	`35`
`36`		`-###### Auto generated by spf13/cobra on 3-Apr-2025`
	`36`	`+###### Auto generated by spf13/cobra on 7-Apr-2025`
Original file line number	Diff line number	Diff line change
`@@ -33,4 +33,4 @@ rain cc rm <name>`
`33`	`33`
`34`	`34`	`* [rain cc](rain_cc.md) - Interact with templates using Cloud Control API instead of CloudFormation`
`35`	`35`
`36`		`-###### Auto generated by spf13/cobra on 3-Apr-2025`
	`36`	`+###### Auto generated by spf13/cobra on 7-Apr-2025`