Skip to content

Commit

Permalink
docs: use tip component on makefile cheat sheet (#38411)
Browse files Browse the repository at this point in the history
  • Loading branch information
jar-b authored Jul 18, 2024
1 parent 0e58082 commit 5dba387
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions docs/makefile-cheat-sheet.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@

The Terraform AWS Provider Makefile includes a lot of functionality to make working on the provider easier and more efficient. Many contributors are familiar with using the Makefile for running acceptance tests, but there is a lot more functionality hidden in this humble file.

**NOTE:** See [Continuous Integration](continuous-integration.md) for more information about the CI-focused parts of the Makefile.
!!! tip
See [Continuous Integration](continuous-integration.md) for more information about the CI-focused parts of the Makefile.

## Basics

Expand Down Expand Up @@ -46,7 +47,8 @@ In the [Cheat Sheet](#cheat-sheet), you can see which variables affect which [ta

Variables are often defined before the `make` call on the same line, such as `MY_VAR=42 make my-target`. However, they can also be set on the same line _after_ the `make` call or in your environment, using, for example, `export MY_VAR=42`.

**NOTE:** Targets that [meta and dependent targets](#meta-targets-and-dependent-targets) run may not all respect the same set of variables.
!!! note
Targets that [meta and dependent targets](#meta-targets-and-dependent-targets) run may not all respect the same set of variables.

* `ACCTEST_PARALLELISM` - (Default: `20`) Number of concurrent acceptance tests to run. Overridden if `P` is set.
* `ACCTEST_TIMEOUT` - (Default: `360m`) Timeout before acceptance tests panic.
Expand Down Expand Up @@ -83,7 +85,8 @@ Variables are often defined before the `make` call on the same line, such as `MY
* **Legacy?**: Indicates whether the target is a legacy holdover. Use caution with a legacy target! It may not work, or it may perform checks or fixes that do _not_ align with current practices. In the future, this target should be removed, modernized, or verified to still have value.
* **Vars**: [Variables](#variables) that you can set when using the target, such as `MY_VAR=42 make my-target`. [Meta and dependent targets](#meta-targets-and-dependent-targets) run other targets that may not respect the same variables.

**TIP:** Makefile autocompletion works out of the box on Zsh (the default shell for Terminal on macOS) and Fish shells. For Bash, the `bash-completion` package, among others, provides Makefile autocompletion. Using autocompletion allows you, for example, to type `make ac`, press _tab_, and the shell autocompletes `make acctest-lint`.
!!! tip
Makefile autocompletion works out of the box on Zsh (the default shell for Terminal on macOS) and Fish shells. For Bash, the `bash-completion` package, among others, provides Makefile autocompletion. Using autocompletion allows you, for example, to type `make ac`, press _tab_, and the shell autocompletes `make acctest-lint`.

| Target | Description | CI? | Legacy? | Vars |
| --- | --- | --- | --- | --- |
Expand Down

0 comments on commit 5dba387

Please sign in to comment.