Skip to content

Latest commit

 

History

History
49 lines (29 loc) · 1.85 KB

dev_guide.md

File metadata and controls

49 lines (29 loc) · 1.85 KB

Developer Guide

Accessing Generated Files

Every push to the main branch on this repo will trigger the Generate GitHub Action which will run generation and upload results as an artifact named "generated".

Download this artifact (see here for info), and unzip it. This will give you the full generated docs folder structure.

You can also trigger the Generate action to run on demand (see here for info) to force generation with the most up-to-date copy of bicep-types-az.

Development

Debugging

In VSCode, use the "Launch CLI" debug target to start the application in debug mode.

Running tests

Run dotnet test to run the test suite.

Updating baselines

If a test failure requires updating the baselines, follow the instructions and run the commands supplied in the error message.

If you want to update all of the baselines in one go, run:

./scripts/update_baselines.sh

Building

Run dotnet build to build this project.

Using the CLI

After building the .NET solution, you can use the CLI by running:

./src/TemplateRefGenerator/bin/Debug/net10.0/TemplateRefGenerator

If you run this command without supplying any arguments, you will see a help message giving information on the supported arguments.

Here's an example of how you can run the CLI tool:

src/TemplateRefGenerator/bin/Debug/net10.0/TemplateRefGenerator --source-folder ../bicep-types-az/generated --output-folder ./generated

To get detailed logging, use the --verbose flag.