CONTRIBUTING.md

Contributing

Run Unit Tests for Terraform CLI Task

1. Navigate to cd tasks\terraform-cli.
2. Run npm run test.

Build in VS Code with docker (including with Github Codespaces)

We have a devcontainer setup so you can run your development environment in Docker or in Github Codespaces. If locally, you will be asked to restart in remote container. To do this you'll need a local docker. Otherwise you can just run the codespace directly from Github.

In either case, you should have everything required to build and test the project.

Build Locally

1. Downgrade to node V6.
2. Ensure you have Python installed and in the path (e.g. winget install python).
3. Ensure you have C++ tools installed. See here https://github.com/nodejs/node-gyp#on-windows.
4. Navigate to the root folder.
5. If you haven't already, setup a https://marketplace.visualstudio.com/manage account and publisher following these steps.
6. Create a file called self.json inside the root folder. The file contents should look like the following, but replace the publisher field with the publisher you setup earlier.

{
    "name": "Terraform CLI (Dev - Individual)",
    "public": false,
    "publisher": "<replace-me-with-your-publisher>"
}

7. Run npm run package:self.
8. This will generate a .vsix file prefixed with your published name.
9. Navigate to your publisher portal: https://marketplace.visualstudio.com/manage/publishers
10. Choose your publisher and select New extension and choose Azure DevOps.
11. You'll be prompted to drag and drop your .vsix file, do that and wait for it to be verified. Ensure you choose that your extension will be Private.
12. Click on the three dots ... next to the extension name and choose Share/Unshare.
13. Click + Organization and enter the name of your Azure DevOps org.
14. Now navigate to your Azure DevOps org and install the extension as you would any other.
15. You are now ready to use the extension and test it.