Verificações de pull request

Ao abrir um pull request (PR) no repositório opentelemetry.io, um conjunto de verificações é executado. As verificações garantem que:

• Você assinou o CLA
• Seu PR é implantado com sucesso através do Netlify
• Suas alterações estão em conformidade com nosso guia de estilo

Easy CLA

Esta verificação falha caso você ainda não tenha assinado o CLA.

Implantação com Netlify

Caso a implantação através do Netlify falhe, selecione Detalhes para mais informações.

GitHub PR checks

Para garantir que as contribuições sigam nosso guia de estilo, implementamos um conjunto de verificações que checam as regras do guia e falham caso encontrem algum problema.

A lista a seguir descreve as verificações atuais e como corrigir os erros relacionados:

TEXT linter

Essa verificação garante que os termos e palavras específicas do OpenTelemetry sejam usados de forma consistente em todo o site.

Se forem encontrados problemas, anotações serão adicionadas aos seus arquivos na visualização arquivos alterados do PR. Corrija estes itens para que a verificação passe. Como alternativa, você pode executar npm run check:text -- --fix localmente para corrigir a maioria dos problemas. Depois, execute npm run check:text novamente e corrija manualmente o que restar.

MARKDOWN linter

Essa verificação garante que sejam aplicados os critérios de padronização e consistência dos arquivos Markdown.

Se forem encontrados problemas, execute npm run fix:format para resolver a maioria deles. Para problemas mais complexos, execute npm run check:markdown e aplique as alterações sugeridas.

SPELLING check

Essa verificação garante que todas as palavras estejam corretamente escritas.

CSPELL check

Essa verificação garante que todas as palavras na lista de ignorados do cSpell estejam normalizadas.

Se essa verificação falhar, execute npm run fix:dict localmente e envie as alterações em um novo commit.

FILENAME check

Essa verificação garante que todos os arquivos estejam formatados com o Prettier.

Se essa verificação falhar, execute npm run fix:format localmente e envie as alterações em um novo commit.

FILE FORMAT

Essa verificação garante que todos os nomes de arquivos estejam em kebab-case.

Se essa verificação falhar, execute npm run fix:filenames localmente e envie as alterações em um novo commit.

BUILD and CHECK LINKS

Essa verificação constrói o site e valida todos os links.

Para verificar os links localmente, execute npm run check:links. Esse comando também atualiza o refcache. Envie as alterações no cache em um novo commit.

Corrigir erros 404

Você deve corrigir as URLs marcadas como inválidas (código HTTP 404) pelo verificador de links.

Lidando com links externos válidos

O verificador de links pode ocasionalmente obter um código de status HTTP diferente de 200 (sucesso) de servidores que bloqueiam verificadores. Esses servidores geralmente retornam um código de status HTTP na faixa de 400, como 401, 403 ou 406, que são os mais comuns. Alguns servidores, como o LinkedIn, reportam 999.

Se você validou manualmente um link externo que o verificador de links não está obtendo um status de sucesso, você pode adicionar o seguinte parâmetro de consulta à sua URL para fazer com que o verificador de links ignore ele: ?no-link-check. Por exemplo, https:/some-example.org?no-link-check será ignorado pelo verificador de links.

./scripts/double-check-refcache-400s.mjs -f --max-num-to-update 99

WARNINGS in build log?

Se essa verificação falhar, revise o log BUILD and CHECK LINKS, na etapa npm run log:check:links, para identificar possíveis problemas adicionais. Caso não tenha certeza de como resolver, peça ajuda aos mantenedores.