CONTRIBUTING.md

Contributing

If you want to get started developing this task, then there are a few setup steps to follow.

Initial Setup

1. Clone the repo.
2. Navigate to the V4 task with cd Tasks/TerraformTask/TerraformTaskV4.
3. Run npm install -include=dev.

Testing

1. Navigate to the V4 task with cd Tasks/TerraformTask/TerraformTaskV4.
2. Run npm test.

Deploying

1. Navigate to the root folder of the repo.
2. If you haven't already, setup a https://marketplace.visualstudio.com/manage account and publisher following these steps.
3. Run npm install -include=dev.
4. Create a file called self.json inside the configs folder. The file contents should look like the following, but replace the publisher field with the publisher you setup earlier.

{
    "id": "custom-terraform-tasks",
    "name": "Terraform (Dev - Individual)",
    "public": false,
    "publisher": "<replace-me-with-your-publisher>",
    "version": "0.1.0"
}

5. Replace the version with the version prior to the one you are want to publish.
6. Run npm run build:release.
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.