Ci

Este recurso está disponível apenas para clientes em planos pagos e para GitHub. O suporte para outras plataformas está chegando em breve. Por favor entre em contato com vendas para mais informações.

Use verificações de CI para analisar seus documentos em busca de erros e fornecer avisos antes de implantar.

Instalação

Para começar, você precisará ter seguido os passos na página do GitHub.

Para GitHub Apps, você pode optar por dar permissões apenas a um único repositório. Recomendamos fortemente que você faça isso, pois só precisamos de acesso ao repositório onde seus documentos estão hospedados.

Configuração

Você pode configurar as verificações de CI habilitadas para uma implantação no painel do Mintlify navegando até a aba ‘Add-Ons’. Lá você pode habilitar ou desabilitar as verificações que deseja executar.

Ao habilitar verificações, você pode escolher executá-las em nível Warning ou Blocking.

Uma verificação de nível Blocking fornecerá um status de falha se não for aprovada ou se mudanças forem sugeridas.

Uma verificação de nível Warning nunca fornecerá um status de falha, mesmo se houver um erro ou sugestões.

Quando Elas São Executadas?

As verificações de CI são configuradas para serem executadas em commits para o seu branch de implantação configurado, ou em pull requests contra esse branch.

Verificações de CI Disponíveis

Links Quebrados

De forma semelhante a como o verificador de links da CLI funciona em sua máquina local, verificaremos automaticamente seus documentos em busca de links quebrados. Para ver os resultados desta verificação, você pode visitar a página de resultados de verificação do GitHub para um commit específico.

Vale

Vale é um linter de prosa de código aberto baseado em regras que suporta uma variedade de tipos de documentos, incluindo Markdown e MDX.

O Mintlify suporta a execução automática do Vale em uma verificação de CI e exibe os resultados como um status de verificação.

Configuração

Se você tiver um arquivo .vale.ini na raiz do diretório de conteúdo para sua implantação, usaremos automaticamente esse arquivo de configuração. Também usaremos automaticamente quaisquer arquivos de configuração em seu stylesPath especificado.

Não tem uma configuração do Vale ou não sabe por onde começar? Não se preocupe, o Mintlify tem uma configuração padrão que será usada automaticamente se uma não for fornecida.

Por favor, note que por razões de segurança, não podemos suportar quaisquer stylesPath, ou stylesPath que incluam valores ... Por favor, use caminhos relativos e inclua o stylesPath em seu repositório.

Pacotes

O Vale suporta uma variedade de pacotes, que podem ser usados para verificar erros de ortografia e estilo. Quaisquer pacotes que você incluir em seu repositório sob o stylesPath correto serão automaticamente instalados e usados em sua configuração do Vale.

Para pacotes não incluídos em seu repositório, você pode especificar quaisquer pacotes do registro de pacotes do Vale, e eles serão automaticamente baixados e usados em sua configuração do Vale.

Por favor, note que por razões de segurança, não podemos suportar o download automático de pacotes que não sejam do registro de pacotes do Vale.

Vale com MDX

O Vale não suporta nativamente MDX, mas o autor do Vale forneceu uma extensão personalizada para suportá-lo.

Se você preferir não usar esta extensão, recomendamos as seguintes linhas em seu .vale.ini file:

[formats]
mdx = md

[*.mdx]
CommentDelimiters = {/*, */}

TokenIgnores = (?sm)((?:import|export) .+?$), \
(?<!`)(<\w+ ?.+ ?\/>)(?!`), \
(<[A-Z]\w+>.+?<\/[A-Z]\w+>)

BlockIgnores = (?sm)^(<\w+\n .*\s\/>)$, \
(?sm)^({.+.*})

Para usar os comentários no documento do Vale, use comentários no estilo MDX {/* ... */}. Se você usar a configuração CommentDelimiters = {/*, */} setting em sua configuração, o Vale interpretará automaticamente esses comentários durante a análise. Isso significa que você pode facilmente usar os recursos internos do Vale, como pular linhas ou seções.

{/* vale off */}

This text will be ignored by Vale

{/* vale on */}

Se você optar por não usar CommentDelimiters, mas ainda escolher usar os comentários do Vale, você deve envolver quaisquer comentários do Vale em comentários MDX {/* ... */}. Por exemplo:

{/* <!-- vale off --> */}

This text will be ignored by Vale

{/* <!-- vale on --> */}

Por favor, note que essas tags de comentário não são suportadas dentro dos componentes do Mintlify, mas podem ser usadas em qualquer lugar no nível base de um documento.