From 4f552188734c08634a32fb5ac22f0c7a749000d2 Mon Sep 17 00:00:00 2001 From: CHIKAMATSU Naohiro Date: Mon, 1 Jan 2024 15:08:24 +0900 Subject: [PATCH 1/2] Add specification document for cfn command. Not implemented yet. --- doc/cfn/README.md | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 doc/cfn/README.md diff --git a/doc/cfn/README.md b/doc/cfn/README.md new file mode 100644 index 0000000..0906fed --- /dev/null +++ b/doc/cfn/README.md @@ -0,0 +1,38 @@ +## cfn - list up or delete CloudFormation stacks +> [!IMPORTANT] +> Not implemented yet. This is specifiction document. + +The cfn command provides the following features: +- [ ] List stacks +- [ ] Delete stacks +- [ ] Add tags to stacks +- [ ] Interactive mode + +### How to install +```shell +go install github.com/nao1215/rainbow/cmd/cfn@latest +``` + +### How to use +The cfn command allows you to specify a profile as an option, but it is more user-friendly to use the `AWS_PROFILE` environment variable. + +### List stacks +```shell +cfn ls +``` + +### Delete stacks +```shell +cfn rm ${STACK_NAME} +``` + +### Add tags to stacks +```shell +cfn tag ${STACK_NAME} ${TAG_KEY}=${TAG_VALUE} +``` + +### Interactive mode +```shell +cfn +``` + From 1e517a46bf926988b6a2ae3450a039feb03415cf Mon Sep 17 00:00:00 2001 From: CHIKAMATSU Naohiro Date: Mon, 1 Jan 2024 15:10:27 +0900 Subject: [PATCH 2/2] Update --- CHANGELOG.md | 5 ++++- README.md | 5 +++-- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index f091b40..84469f9 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,8 @@ -## [](https://github.com/nao1215/rainbow/compare/77bdf974281a...) (2023-12-29) +## [](https://github.com/nao1215/rainbow/compare/77bdf974281a...) (2024-01-01) +* Introduce spare command [#13](https://github.com/nao1215/rainbow/pull/13) ([nao1215](https://github.com/nao1215)) +* build(deps): bump golang.org/x/sync from 0.1.0 to 0.5.0 [#12](https://github.com/nao1215/rainbow/pull/12) ([dependabot[bot]](https://github.com/apps/dependabot)) +* Update document for s3hub with gif image [#11](https://github.com/nao1215/rainbow/pull/11) ([nao1215](https://github.com/nao1215)) * Add remove subcommand [#10](https://github.com/nao1215/rainbow/pull/10) ([nao1215](https://github.com/nao1215)) * Add ls subcommand [#9](https://github.com/nao1215/rainbow/pull/9) ([nao1215](https://github.com/nao1215)) * Add s3hub mb subcommand [#8](https://github.com/nao1215/rainbow/pull/8) ([nao1215](https://github.com/nao1215)) diff --git a/README.md b/README.md index 81fe00d..06b64cf 100644 --- a/README.md +++ b/README.md @@ -25,8 +25,9 @@ The rainbow project is a toolset for managing AWS resources. This project consis [WIP] |Name|README|implementation|Description| |:--|:--|:--|:--| -|[s3hub](./doc/s3hub/README.md)|✅||User-friendly s3 management tool| -|[spare](./doc/spare/README.md)|✅||Single Page Application Release Easily| +|[s3hub](./doc/s3hub/README.md)|✅|60%|User-friendly s3 management tool| +|[spare](./doc/spare/README.md)|✅|50%|Single Page Application Release Easily| +|[cfn](./doc/cfn/README.md)|✅|0%|List up or delete CloudFormation stacks| ### s3hub example #### Create a bucket(s)