Skip to content

Commit 636cb64

Browse files
Change AVM script commands for Windows (#2311)
1 parent 8d69615 commit 636cb64

File tree

2 files changed

+8
-6
lines changed

2 files changed

+8
-6
lines changed

docs/content/contributing/terraform/terraform-contribution-flow/_index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ AVM performs end-to-end (e2e) test deployments of all modules in Azure for valid
159159
$env:ARM_CLIENT_SECRET = "<service_principal_password>"
160160
```
161161

162-
2. Change to the root of your module repository and run `./avm docscheck` (Linux/MacOs) / `avm.bat docscheck` (Windows) to verify the container image is working as expected or needs to be pulled first. You will need this later.
162+
2. Change to the root of your module repository and run `./avm docscheck` (Linux/MacOs) / `./avm docscheck` (Windows) to verify the container image is working as expected or needs to be pulled first. You will need this later.
163163

164164
![PullLatestAzterraformContainerImage]({{% siteparam base %}}/images/contribution/pullImage.png "Pull latest azterraform container image")
165165

@@ -201,8 +201,8 @@ The following commands will run all pre-commit checks and the pr-check.
201201
./avm pr-check
202202
203203
## Windows
204-
avm.bat pre-commit
205-
avm.bat pr-check
204+
./avm pre-commit
205+
./avm pr-check
206206
```
207207

208208
#### 4.2 Run e2e tests
@@ -211,7 +211,7 @@ Currently you have two options to run e2e tests:
211211

212212
{{% notice style="note" %}}
213213

214-
With the help of the [avm](https://github.com/Azure/terraform-azurerm-avm-template/blob/main/avm) script and the commands `./avm test-example` (Linux/MacOs) / `avm.bat test-example` (Windows) you will be able to run it in a more simplified way. Currently the `test-example` command is not completely ready yet and will be released soon. Therefore please use the below docker command for now.
214+
With the help of the [avm](https://github.com/Azure/terraform-azurerm-avm-template/blob/main/avm) script and the commands `./avm test-example` (Linux/MacOs) / `./avm test-example` (Windows) you will be able to run it in a more simplified way. Currently the `test-example` command is not completely ready yet and will be released soon. Therefore please use the below docker command for now.
215215

216216
{{% /notice %}}
217217

docs/content/contributing/terraform/testing.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,9 +43,11 @@ You need to have the following tools installed:
4343

4444
### Windows
4545

46+
Run the following from a PowerShell 7.x command prompt (e.g. VSCode terminal):
47+
4648
```powershell
47-
.\avm.bat pre-commit
48-
.\avm.bat pr-check
49+
./avm pre-commit
50+
./avm pr-check
4951
```
5052

5153
Doing so will shorten the development cycle and ensure that your module is compliant with the AVM specifications.

0 commit comments

Comments
 (0)