search

microsoft / azure-devops-engineering-extensions

AzureDevOps marketplace extension that contains various engineering oriented Pipeline tasks
MIT License
19 stars 20 forks source link
azuredevops-extension

readme

Azure DevOps Engineering Marketplace Extensions

AzureDevOps Marketplace Extensions to do various engineering tasks.

Email Report Task

Generates a Report with the information from the pipeline and sends it as email. Goal is to provide all the relevant info happened in the pipeline, in a concise and neat manner.

Read more about V1 here. Read more about V2 here.

Pull Request Insights Task

PullRequestInsightsTask provides insights into pipelines. This extension has two main functions:

  1. Investigating pull request validation failures
  2. Alerting pull request owners to the introduction of long running tasks.

Read more here.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com. When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA. This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

To build:

npm install
npm run build // builds all tasks
npm run build:t1 // build specific task - first task
npm run build:t2 // builds second task - Refer package.json

To run unit tests (at root): 

npm test

To run PullRequestInsights task E2E w/o installing it on a pipeline: 

npm run e2e:emailreport // or look below
npm run e2e:t1 // proxy for above
npm run e2e:t2 // proxy for prinsights

VS Code Debugging option is also available. Use launch.json under .vscode directory. Note: E2E test(s) will fail by default with 401 errors as the restclients are not authenticated without providing correct credentials. Change E2E test code to supply correct credentials to test the scenario.

Packaging:

Run the pack command for each task. t1/t2/... are shortcuts for tasks in alphabhetical order. Please check package.json to confirm or use the actual names if preferred.

npm run pack:t1 // if option not specified, "dev" is default. Doesn't create VSIX.
npm run pack:t1 prod // creates VSIX for emailReport
npm run pack:t2  // Doesn't create VSIX
npm run pack:t2 prod // Creates VSIX for pullRequestInsights

Note: Option "dev" doesn't create a VSIX file. Instead, it prepares the output task folder ready for upload to an AzureDevOps account and test it.