Skip to content

Commit f8b5acc

Browse files
chore: update documentation
1 parent da35c6b commit f8b5acc

File tree

1 file changed

+61
-11
lines changed

1 file changed

+61
-11
lines changed

Makefile.md

Lines changed: 61 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,46 +3,96 @@
33
```
44
Available targets:
55
6-
aws/cli-version Display AWS CLI version
6+
aws/cfn-lint/install Install AWS CloudFormation Linter
7+
aws/cli/install Install AWS Command Line Interface v2
8+
aws/cli/version Display AWS CLI version
9+
aws/cloudformation/create-change-set Creates a list of changes that will be applied to a stack so that you can review the changes before executing them.
10+
aws/cloudformation/create-change-set-without-parameters Creates a list of changes that will be applied to a stack so that you can review the changes before executing them.
11+
aws/cloudformation/create-folder-structure Create a folder structure for CloudFormation projects
12+
aws/cloudformation/create-parameters Copy a CloudFormation parameters to be used as example
13+
aws/cloudformation/create-project Create a CloudFormation project structure
14+
aws/cloudformation/create/service-linked-role Creates an IAM role that is linked to a specific Amazon Elasticsearch service.
15+
aws/cloudformation/create-stack Creates a stack as specified in the template.
16+
aws/cloudformation/create-stack-without-parameters Creates a stack as specified in the template. (don't pass --parameters flag)
17+
aws/cloudformation/create-template-yaml Copy a CloudFormation template to be used as example
18+
aws/cloudformation/delete-change-set Delete latest change-set created
19+
aws/cloudformation/delete/service-linked-role Deletes an IAM role that is linked to a specific Amazon Web Services service.
20+
aws/cloudformation/delete-stack Delete CloudFormation Stack
21+
aws/cloudformation/describe-stack-events Returns all stack related events for a specified stack in reverse chronological order.
22+
aws/cloudformation/describe-stack Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created.
23+
aws/cloudformation/detect-stack-drift Detects whether a stack's actual configuration differs, or has drifted , from it's expected configuration, as defined in the stack template and any values specified as template parameters.
24+
aws/cloudformation/estimate-template-cost Returns the estimated monthly cost of a template
25+
aws/cloudformation/execute-change-set Execute latest change-set
26+
aws/cloudformation/hygiene Execute CFN Lint and pre-commit rules
27+
aws/cloudformation/latest-change-set Display latest change-set
28+
aws/codeartifact/login Login into AWS CodeArtifact
29+
aws/ssm/install-plugin Install AWS SSM plugin
30+
aws/ssm/start-session Start session with AWS Systems Manager Session Manager
31+
aws/sso/login Login into AWS account and export credentials to ~/.aws/credentials
32+
aws/sts/get-caller-identity Returns details about the IAM user or role whose credentials are used to call the operation.
733
checkov/run Run Checkov
834
checkov/version Display checkov version
9-
doc/build Build README.md based on doc/README.yaml (and/or doc/.terraform-docs.yml)
10-
doc/init Initialize project's documentation
11-
gitignore/init Create a .gitignore file with most common rules
35+
doc/build Builds documentation
36+
doc/init Initialize documentation
37+
docker/prune Remove unused images and all stopped containers
38+
docker/remove-containers Remove all Docker containers
39+
docker/remove-images Remove all Docker images
40+
docker/remove-volumes Remove all Docker volumes
41+
git/config/init Initialize git configuration for project
42+
github/actions/init Initialize .github/actions directory
43+
github/issues/init Initialize .github/issues directory
44+
github/pull-request/init Initialize .github/pull-request directory
45+
github/workflows/init Initialize .github/workflows directory
46+
gitignore/init Create .gitignore file
47+
gitignore/install Install gitignore
48+
gitignore/list List all gitignore templates
1249
go/install Install Golang
1350
gomplate/version Display Gomplate version
1451
go/version Display Go version
52+
habits/check Performs checks
53+
habits/init Initialize gitignore, documentation, pre-commit, github workflows, issues and pull-request
54+
habits/install Install Habits dependencies
55+
habits/remove Uninstall Habits
56+
habits/update Update Habits
1557
help/clean Help screen
16-
init Initialize project with default configuration
17-
pre-commit/install-hooks Install pre-commit hooks
58+
nodejs/install Install NodeJS
59+
npm/install Install NPM
60+
pre-commit/hooks/install Install pre-commit hooks
61+
pre-commit/init Initialize .pre-commit-config.yaml to working directoy
1862
pre-commit/install Install pre-commit using Pip3
63+
pre-commit/remove Remove .pre-commit-config.yaml
1964
pre-commit/run Execute pre-commit hooks on all files
20-
pre-commit/update Update pre-commit-config.yml with the latest version
65+
pre-commit/update Update pre-commit-config.yaml with the latest version
2166
pre-commit/version Display pre-commit version
2267
python/install Install Python 3
23-
python/pip-install Install Python 3 Pip
68+
python/pip/install Install Python 3 Pip
2469
python/version Display Python & Pip version
25-
python/virtualenv-create Create a Python 3 virtualenv in the current directory
26-
python/virtualenv Install Python 3 virtualenv
70+
python/virtualenv/init Initialize a Python 3 virtualenv in the current directory
71+
python/virtualenv/install Install Python 3 virtualenv
72+
python/virtualenv/remove Remove Python 3 virtualenv in the current directory
2773
terraform/apply Builds or changes infrastructure according to Terraform configuration files in DIR
2874
terraform/clean Remove temporary files and directories
2975
terraform/destroy Destroy Terraform-managed infrastructure.
3076
terraform-docs/build Build doc/terraform-docs.md with Terraform Docs
31-
terraform-docs/init Create initl configuration
3277
terraform-docs/version Display Terraform Docs version
3378
terraform/fmt Check if the input is formatted. Exit status will be 0 if all input is properly formatted and non-zero otherwise.
3479
terraform/init/backend Initialize a new or existing Terraform working directory by creating initial files, loading any remote state, downloading modules, etc.
3580
terraform/init Initialize a new or existing Terraform working directory by creating initial files, loading any remote state, downloading modules, etc.
81+
terraform/install Install Terraform latest version
3682
terraform/plan Generates an execution plan for Terraform
3783
terraform/validate Validate the configuration files in a directory, referring only to the configuration and not accessing any remote services such as remote state, provider APIs, etc.
3884
terraform/version Display Terraform version
3985
terrascan/run Run Terrascan
4086
terrascan/version Display Terrascan version
87+
tflint/init/force Init AWS TFLINT, overwrite current configuration
4188
tflint/init Init AWS TFLINT
89+
tflint/run Run TFLINT
4290
tflint/version Display TFLINT version
4391
tfsec/run Run TFSEC
4492
tfsec/version Display TFSEC version
4593
tfswitch/run Execute tfswitch
4694
tfswitch/version Display tfswitch version
95+
ubuntu/install Install most common packages
96+
ubuntu/update Update and upgrade Ubuntu packages
4797
4898
```

0 commit comments

Comments
 (0)