Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: Updated go install command #219

Merged
merged 3 commits into from Dec 7, 2023
Merged

docs: Updated go install command #219

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d5299c3
docs: Updated go install command
khmoryz Dec 5, 2023
8cc06a6
docs: Update README.tmpl go install command
khmoryz Dec 6, 2023
29e548e
docs: Execute go generate
khmoryz Dec 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Expand Up @@ -43,7 +43,7 @@ If you have [homebrew](https://brew.sh/) installed, `brew install rain`

Or you can download the appropriate binary for your system from [the releases page](https://github.com/aws-cloudformation/rain/releases).

Or if you're a [Gopher](https://blog.golang.org/gopher), you can `GO111MODULE=on go install github.com/aws-cloudformation/rain/cmd/rain`
Or if you're a [Gopher](https://blog.golang.org/gopher), you can `go install github.com/aws-cloudformation/rain/cmd/rain@latest`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changes need to be made to the readme template file.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ericzbeard
I didn't notice the template file.
Thanks for your review.

I fixed the issue in 8cc06a6 .

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Run go generate ./... and then push another commit with the generated files.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I did it at 29e548e.

And...
I noticed cfn.go is updated.
This automation is awesome!


```
Usage:
Expand Down
8,326 changes: 6,942 additions & 1,384 deletions cft/spec/cfn.go
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/README.tmpl
View file
Open in desktop
Expand Up @@ -43,7 +43,7 @@ If you have [homebrew](https://brew.sh/) installed, `brew install rain`

Or you can download the appropriate binary for your system from [the releases page](https://github.com/aws-cloudformation/rain/releases).

Or if you're a [Gopher](https://blog.golang.org/gopher), you can `GO111MODULE=on go install github.com/aws-cloudformation/rain/cmd/rain`
Or if you're a [Gopher](https://blog.golang.org/gopher), you can `go install github.com/aws-cloudformation/rain/cmd/rain@latest`

```
{{.Usage}}```
Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
View file
Open in desktop
Expand Up @@ -34,4 +34,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 15-Nov-2023
###### Auto generated by spf13/cobra on 7-Dec-2023
2 changes: 1 addition & 1 deletion docs/rain_bootstrap.md
View file
Open in desktop
Expand Up @@ -30,4 +30,4 @@ rain bootstrap

* [rain](index.md) -

###### Auto generated by spf13/cobra on 15-Nov-2023
###### Auto generated by spf13/cobra on 7-Dec-2023
2 changes: 1 addition & 1 deletion docs/rain_build.md
View file
Open in desktop
Expand Up @@ -30,4 +30,4 @@ rain build [<resource type>...]

* [rain](index.md) -

###### Auto generated by spf13/cobra on 15-Nov-2023
###### Auto generated by spf13/cobra on 7-Dec-2023
2 changes: 1 addition & 1 deletion docs/rain_cat.md
View file
Open in desktop
Expand Up @@ -31,4 +31,4 @@ rain cat <stack>

* [rain](index.md) -

###### Auto generated by spf13/cobra on 15-Nov-2023
###### Auto generated by spf13/cobra on 7-Dec-2023
2 changes: 1 addition & 1 deletion docs/rain_console.md
View file
Open in desktop
Expand Up @@ -38,4 +38,4 @@ rain console [stack]

* [rain](index.md) -

###### Auto generated by spf13/cobra on 15-Nov-2023
###### Auto generated by spf13/cobra on 7-Dec-2023
2 changes: 1 addition & 1 deletion docs/rain_deploy.md
View file
Open in desktop
Expand Up @@ -70,4 +70,4 @@ rain deploy <template> [stack]

* [rain](index.md) -

###### Auto generated by spf13/cobra on 15-Nov-2023
###### Auto generated by spf13/cobra on 7-Dec-2023
2 changes: 1 addition & 1 deletion docs/rain_diff.md
View file
Open in desktop
Expand Up @@ -28,4 +28,4 @@ rain diff <from> <to>

* [rain](index.md) -

###### Auto generated by spf13/cobra on 15-Nov-2023
###### Auto generated by spf13/cobra on 7-Dec-2023
2 changes: 1 addition & 1 deletion docs/rain_fmt.md
View file
Open in desktop
Expand Up @@ -32,4 +32,4 @@ rain fmt <filename>...

* [rain](index.md) -

###### Auto generated by spf13/cobra on 15-Nov-2023
###### Auto generated by spf13/cobra on 7-Dec-2023
2 changes: 1 addition & 1 deletion docs/rain_forecast.md
View file
Open in desktop
Expand Up @@ -59,4 +59,4 @@ rain forecast --experimental <template> [stackName]

* [rain](index.md) -

###### Auto generated by spf13/cobra on 15-Nov-2023
###### Auto generated by spf13/cobra on 7-Dec-2023
2 changes: 1 addition & 1 deletion docs/rain_info.md
View file
Open in desktop
Expand Up @@ -30,4 +30,4 @@ rain info

* [rain](index.md) -

###### Auto generated by spf13/cobra on 15-Nov-2023
###### Auto generated by spf13/cobra on 7-Dec-2023
2 changes: 1 addition & 1 deletion docs/rain_logs.md
View file
Open in desktop
Expand Up @@ -36,4 +36,4 @@ rain logs <stack> (<resource>)

* [rain](index.md) -

###### Auto generated by spf13/cobra on 15-Nov-2023
###### Auto generated by spf13/cobra on 7-Dec-2023
2 changes: 1 addition & 1 deletion docs/rain_ls.md
View file
Open in desktop
Expand Up @@ -30,4 +30,4 @@ rain ls <stack>

* [rain](index.md) -

###### Auto generated by spf13/cobra on 15-Nov-2023
###### Auto generated by spf13/cobra on 7-Dec-2023
2 changes: 1 addition & 1 deletion docs/rain_merge.md
View file
Open in desktop
Expand Up @@ -29,4 +29,4 @@ rain merge <template> <template> ...

* [rain](index.md) -

###### Auto generated by spf13/cobra on 15-Nov-2023
###### Auto generated by spf13/cobra on 7-Dec-2023
2 changes: 1 addition & 1 deletion docs/rain_pkg.md
View file
Open in desktop
Expand Up @@ -66,4 +66,4 @@ rain pkg <template>

* [rain](index.md) -

###### Auto generated by spf13/cobra on 15-Nov-2023
###### Auto generated by spf13/cobra on 7-Dec-2023
2 changes: 1 addition & 1 deletion docs/rain_rm.md
View file
Open in desktop
Expand Up @@ -32,4 +32,4 @@ rain rm <stack>

* [rain](index.md) -

###### Auto generated by spf13/cobra on 15-Nov-2023
###### Auto generated by spf13/cobra on 7-Dec-2023
2 changes: 1 addition & 1 deletion docs/rain_stackset.md
View file
Open in desktop
Expand Up @@ -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 15-Nov-2023
###### Auto generated by spf13/cobra on 7-Dec-2023
2 changes: 1 addition & 1 deletion docs/rain_stackset_deploy.md
View file
Open in desktop
Expand Up @@ -64,4 +64,4 @@ rain stackset deploy <template> [stackset] [flags]

* [rain stackset](rain_stackset.md) - This command manipulates stack sets.

###### Auto generated by spf13/cobra on 15-Nov-2023
###### Auto generated by spf13/cobra on 7-Dec-2023
2 changes: 1 addition & 1 deletion docs/rain_stackset_ls.md
View file
Open in desktop
Expand Up @@ -30,4 +30,4 @@ rain stackset ls <stack set>

* [rain stackset](rain_stackset.md) - This command manipulates stack sets.

###### Auto generated by spf13/cobra on 15-Nov-2023
###### Auto generated by spf13/cobra on 7-Dec-2023
2 changes: 1 addition & 1 deletion docs/rain_stackset_rm.md
View file
Open in desktop
Expand Up @@ -30,4 +30,4 @@ rain stackset rm <stackset>

* [rain stackset](rain_stackset.md) - This command manipulates stack sets.

###### Auto generated by spf13/cobra on 15-Nov-2023
###### Auto generated by spf13/cobra on 7-Dec-2023
2 changes: 1 addition & 1 deletion docs/rain_tree.md
View file
Open in desktop
Expand Up @@ -30,4 +30,4 @@ rain tree [template]

* [rain](index.md) -

###### Auto generated by spf13/cobra on 15-Nov-2023
###### Auto generated by spf13/cobra on 7-Dec-2023
2 changes: 1 addition & 1 deletion docs/rain_watch.md
View file
Open in desktop
Expand Up @@ -30,4 +30,4 @@ rain watch <stack>

* [rain](index.md) -

###### Auto generated by spf13/cobra on 15-Nov-2023
###### Auto generated by spf13/cobra on 7-Dec-2023