From 02235674f35eaa6ca5a9099ff504bee34209767e Mon Sep 17 00:00:00 2001 From: billytrend Date: Thu, 13 Jun 2019 13:43:33 -0700 Subject: [PATCH] Add instructions for regression fixes (#430) * Add instructions for regression fixes * Update README.md --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index fb22f2d8..3667e5d2 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,9 @@ [![Build Status](https://dev.azure.com/azure-public/adx/_apis/build/status/public.Azure.oav)](https://dev.azure.com/azure-public/adx/_build/latest?definitionId=3) [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier) + +Regression: [![Build Status](https://dev.azure.com/azure-sdk/public/_apis/build/status/OAV%20Validate%20Examples%20Regression?branchName=master)](https://dev.azure.com/azure-sdk/public/_build/latest?definitionId=163&branchName=master) [How to fix this](#fixing-regression-builds) + Tools for validating OpenAPI (Swagger) files. ## Requirements @@ -134,6 +137,15 @@ Output of the OAV tool has been snapshotted and committed to the repo. The regre [Slow Regression (~1 hour)](https://dev.azure.com/azure-sdk/public/_build?definitionId=163&_a=completed) is run after merge and should be fixed if it fails +#### Fixing regression builds + +1. Go to the failed build +2. Download the artifact patch file +3. In the OAV directory run `git apply ` +4. Commit the patched changes and create a pull request +5. Validate that the changes look ok and don't represent a breaking change in OAV +6. Merge the PR + --- This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.