Skip to content

Commit

Permalink
Add instructions for regression fixes (Azure#430)
Browse files Browse the repository at this point in the history
* Add instructions for regression fixes

* Update README.md
  • Loading branch information
billytrend committed Jun 13, 2019
1 parent 317296b commit 0223567
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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 <path to patch file>`
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.

0 comments on commit 0223567

Please sign in to comment.