Skip to content

Commit

Permalink
Update ci-fix.md: upgrade Avocado stuff (#25568)
Browse files Browse the repository at this point in the history
  • Loading branch information
Konrad Jamrozik authored Aug 29, 2023
1 parent d4ceb3d commit 0762e82
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions documentation/ci-fix.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# CI Fix Guide

Short link: https://aka.ms/ci-fix
Short link: https://aka.ms/azsdk/ci-fix

This page provides detailed instructions on how to diagnose, reproduce, fix and get help on various [automated validation tooling] failures on your [Azure REST API specs PR].

Expand Down Expand Up @@ -109,7 +109,11 @@ To reproduce LintDiff failures locally, see [CONTRIBUTING.md / How to locally re

## Avocado

Run avocado locally:
### Get help fixing Avocado validation failures

Refer to [Avocado README](https://github.com/Azure/avocado/blob/master/README.md) for detailed description of validations and how-to-fix guidance.

### Run avocado locally

```
npm install -g @azure/avocado
Expand All @@ -124,8 +128,6 @@ Note: When running in Swagger PR pipeline, Avocado only report errors with file
- Run all specs: Clone the repo `azure/azure-rest-api-specs` and run "avocado" in folder `azure/azure-rest-api-specs`.
- Run single service specs: create a folder `specification`. and move your service specs folder in `specification`. run "avocado"

Refer to [Avocado Readme](https://github.com/Azure/avocado/blob/master/README.md) for detailed description of validations and how-to-fix guidance.

## API Doc Preview

If you see `Swagger ApiDocPreview ` check fail with a failure [like this one](https://github.com/Azure/azure-rest-api-specs/pull/24841/checks?check_run_id=15056283615):
Expand Down

0 comments on commit 0762e82

Please sign in to comment.