mintlify__docs/fr/deploy/ci.mdx

---
title: "Vérifications CI"
description: "Automatisez les contrôles qualité de la documentation dans votre pipeline CI/CD avec détection de liens brisés, linting, grammaire et aperçus de build."
keywords: ["continuous integration", "CI/CD", "checks", "Vale", "linter"]
---

<Info>
  Les [offres Pro et Enterprise](https://mintlify.com/pricing?ref=docs-ci) incluent des vérifications CI pour les dépôts GitHub.
</Info>

Utilisez les vérifications CI pour analyser votre documentation, détecter les erreurs et signaler des avertissements avant le déploiement. Les vérifications CI de Mintlify s’exécutent sur les pull requests (demandes de fusion) visant une branche de déploiement configurée.

<div id="installation">
  ## Installation
</div>

Pour commencer, suivez les étapes indiquées sur la page [GitHub](/fr/deploy/github).

<Tip>
  L’application GitHub de Mintlify n’a besoin que de l’accès au référentiel où se trouve le contenu de votre documentation. Nous recommandons de n’accorder l’accès qu’à ce référentiel uniquement.
</Tip>

## Configuration

Configurez les contrôles CI activés pour un déploiement en accédant à la page [Modules complémentaires](https://app.mintlify.com/settings/deployment/addons) de votre Dashboard. Activez les contrôles que vous souhaitez exécuter.

Lors de l’activation des contrôles, vous pouvez choisir de les exécuter au niveau `Avertissement` ou `Bloquant`.

- Un contrôle de niveau `Avertissement` n’indique jamais un statut d’échec, même en cas d’erreur ou de suggestions.
- Un contrôle de niveau `Bloquant` indique un statut d’échec en cas d’erreur ou de suggestions.

<div id="available-ci-checks">
  ## Vérifications CI disponibles
</div>

<div id="broken-links">
  ### Liens cassés
</div>

Comme le [vérificateur de liens de la CLI](/fr/cli/commands#mint-broken-links) sur votre machine locale, la vérification CI des liens cassés recherche automatiquement les liens internes cassés entre les pages de votre site dans le contenu de votre documentation. Elle ne vérifie pas les liens externes vers d'autres sites web.

Pour voir les résultats détaillés des liens cassés sur une pull request, cliquez sur l'onglet **Checks** et sélectionnez la vérification des liens cassés Mintlify. Les résultats listent les fichiers contenant des liens cassés trouvés dans la pull request.

<div id="vale">
  ### Vale
</div>

[Vale](https://vale.sh/) est un linter de prose open source basé sur des règles qui prend en charge un large éventail de types de documents, y compris Markdown et MDX. Utilisez Vale pour vérifier la cohérence du style et du ton de votre documentation.

Mintlify permet d’exécuter automatiquement Vale dans un contrôle CI et d’afficher les résultats comme statut de contrôle.

<div id="configuration">
  #### Configuration
</div>

Si vous avez un fichier `.vale.ini` à la racine du répertoire de contenu de votre déploiement, la vérification Vale CI utilise ce fichier de configuration ainsi que tous les fichiers de configuration présents dans le `StylesPath` que vous avez spécifié.

Si vous n’avez pas de fichier de configuration Vale, la configuration par défaut est automatiquement chargée.

<Note>
  La configuration par défaut s’exécute dans l’environnement de build de Mintlify, où `StylesPath = /app/styles` pointe vers un répertoire interne. Si vous créez votre propre fichier `.vale.ini`, utilisez un chemin relatif dans votre référentiel, par exemple `StylesPath = styles`.

  Pour des raisons de sécurité, vous ne pouvez pas utiliser de chemins absolus ni de chemins contenant `..` dans vos fichiers de configuration.
</Note>

```mdx Default vale.ini configuration expandable
# Top level styles
StylesPath = /app/styles
MinAlertLevel = suggestion
# Inline HTML tags to ignore (code/tt for code snippets, img/url for links/images, a for anchor tags)
IgnoredScopes = code, tt, img, url, a
SkippedScopes = script, style, pre, figure

# Vocabularies
Vocab = Mintlify

# Analyser MDX comme MD pour éviter la fragilité avec JSX
[formats]
mdx = md

# Only match MDX
[*.mdx]
BasedOnStyles = Vale
Vale.Terms = NO # Enforces really harsh capitalization rules, keep off

# Ignore JSX/MDX-specific syntax patterns
# `import ...`, `export ...`
# `<Component ... />`
# `<Component>...</Component>`
# `{ ... }`
TokenIgnores = (?sm)((?:import|export) .+?$), \
(?<!`)(<\w+ ?.+ ?\/>)(?!`), \
(<[A-Z]\w+>.+?<\/[A-Z]\w+>), \
\{[^}]*\}

# Exclude multiline JSX and curly braces
# `<Component \n ... />`
BlockIgnores = (?sm)^(<\w+\n .*\s\/>)$, \
(?sm)^({.+.*})
```

Le vocabulaire par défaut de Vale comprend les mots suivants.

```text Default Vale vocabulary expandable
Mintlify
mintlify
VSCode
openapi
OpenAPI
GitHub
APIs

repo
npm
dev

Lorem
ipsum
impsum
amet

const
myName
myObject
bearerAuth
favicon
topbar
url
borderRadius
args
modeToggle
ModeToggle
isHidden
autoplay

_italic_
Strikethrough
Blockquotes
Blockquote
Singleline
Multiline

onboarding

async
await
boolean
enum
func
impl
init
instanceof
typeof
params
stdin
stdout
stderr
stdout
stdin
var
const
let
null
undefined
struct
bool

cors
csrf
env
xhr
xhr2
jwt
oauth
websocket
localhost
middleware
runtime
webhook
stdin
stdout

json
yaml
yml
md
txt
tsx
jsx
css
scss
html
png
jpg
svg

cdn
cli
css
dom
dto
env
git
gui
http
https
ide
jvm
mvc
orm
rpc
sdk
sql
ssh
ssl
tcp
tls
uri
url
ux
ui

nodejs
npm
yarn
pnpm
eslint
pytest
golang
rustc
kubectl
mongo
postgres
redis

JavaScript
TypeScript
Python
Ruby
Rust
Go
Golang
Java
Kotlin
Swift
Node.js
NodeJS
Deno

React
Vue
Angular
Next.js
Nuxt
Express
Django
Flask
Spring
Laravel
Redux
Vuex
TensorFlow
PostgreSQL
MongoDB
Redis
PNPM

Docker
Kubernetes
AWS
Azure
GCP
Terraform
Jenkins
CircleCI
GitLab
Heroku

Git
git
GitHub
GitLab
Bitbucket
VSCode
Visual Studio Code
IntelliJ
WebStorm
ESLint
eslint
Prettier
prettier
Webpack
webpack
Vite
vite
Babel
babel
Jest
jest
Mocha
Cypress
Postman

HTTP
HTTPS
OAuth
JWT
GraphQL
REST
WebSocket
TCP/IP

NPM
Yarn
PNPM
Pip
PIP
Cargo
RubyGems

Swagger
OpenAPI
Markdown
MDX
Storybook
TypeDoc
JSDoc

MySQL
PostgreSQL
MongoDB
Redis
Elasticsearch
DynamoDB

Linux
Unix
macOS
iOS

Firefox
Chromium
WebKit

config
ctx
desc
dir
elem
err
len
msg
num
obj
prev
proc
ptr
req
res
str
tmp
val
vars

todo
href
lang
nav
prev
next
toc
```

Pour ajouter votre propre vocabulaire à la configuration par défaut, créez un répertoire `styles/config/vocabularies/Mintlify` contenant les fichiers `accept.txt` et `reject.txt`.


* `accept.txt` : Mots que le linter Vale doit ignorer. Par exemple, des noms de produits ou des termes peu courants.
* `reject.txt` : Mots que le linter Vale doit signaler comme des erreurs. Par exemple, du jargon ou des mots qui ne sont pas appropriés au ton de votre documentation.

```text Example Vale file structure
/votre-projet
  |- docs.json
  |- .vale.ini
  |- styles/
    |- config/
      |- vocabularies/
        |- Mintlify/
          |- accept.txt
          |- reject.txt
  |- page-exemple.mdx
```

```text Example monorepo Vale file structure
/your-monorepo
  |- main.ts
  |- docs/
    |- docs.json
    |- .vale.ini
    |- styles/
      |- config/
        |- vocabularies/
          |- Mintlify/
            |- accept.txt
            |- reject.txt
    |- example-page.mdx
  |- test/
```

<div id="packages">
  #### Packages
</div>

Vale prend en charge une gamme de [packages](https://vale.sh/docs/keys/packages) qui détectent les fautes d’orthographe et les erreurs de style. Tous les packages que vous ajoutez à votre référentiel sous le `StylesPath` approprié s’installent et s’exécutent automatiquement avec votre configuration Vale.

Pour les packages qui ne sont pas inclus dans votre référentiel, vous pouvez spécifier n’importe quel package du [registre de packages Vale](https://vale.sh/explorer), qui sera automatiquement téléchargé et utilisé dans votre configuration Vale.

<Note>
  Pour des raisons de sécurité, vous ne pouvez pas télécharger automatiquement des packages qui ne proviennent pas du [registre de packages Vale](https://vale.sh/explorer).
</Note>

<div id="vale-with-mdx">
  #### Vale avec `MDX`
</div>

<Note>
  La prise en charge native de MDX nécessite Vale 3.10.0 ou une version ultérieure. Vérifiez votre version de Vale avec `vale --version`.
</Note>

Pour utiliser les commentaires intégrés de Vale dans les fichiers MDX, utilisez les commentaires au format MDX `{/* ... */}` :

```mdx
{/* vale off */}

Vale ignore ce texte

{/* vale on */}
```

Vale reconnaît et respecte automatiquement ces commentaires dans les fichiers MDX sans configuration supplémentaire. Utilisez les commentaires pour ignorer les lignes ou sections que vous souhaitez que le linter ignore.

<Warning>
  Ne placez pas de commentaires d&#39;expression MDX tels que `{/* vale off */}` en tant qu&#39;enfants directs d&#39;un composant JSX entre des éléments frères. Par exemple, entre deux éléments `<Step>` à l&#39;intérieur d&#39;un composant `<Steps>`.

  Placez les commentaires dans le contenu d&#39;un élément spécifique ou remaniez la structure du contenu pour éviter d&#39;avoir besoin de commentaires.
</Warning>