12.12.2024

Usando HTML nas Descrições de Jobs do Jenkins: Uma Solução

Resposta Rápida

Você precisará do plugin Safe HTML para incorporar código HTML nas descrições de jobs do Jenkins. Siga as instruções abaixo:

1. Navegue até Gerenciar Jenkins, então selecione Configurar Segurança Global.
2. Na seção Formatação de Marcação, escolha Safe HTML.

Aqui está um exemplo de uso de HTML:

<b>Construção:</b> <span style="color:green;">Bem-sucedida</span>

Tenha em mente que apenas um conjunto limitado de tags HTML pode ser usado por motivos de segurança.

Plugins e Configuração

Vamos explorar algumas maneiras de aprimorar suas descrições de jobs no Jenkins:

Instalando Safe HTML Através da Interface Web

Método Rápido:

1. Vá para Gerenciar Jenkins, depois navegue até Configurar Segurança Global.
2. Localize a opção Formatação de Marcação e altere para Safe HTML para habilitar a funcionalidade HTML.

Habilitação Programática com o Plugin JASC

Se você prefere programar através de Configuração como Código, use o plugin CASC:

1. Seu arquivo de configuração deve conter a linha markupFormatter: safeHtml.
2. Aplique as configurações, e seus jobs poderão incluir descrições em HTML!

O plugin CASC é ideal para configurações de instâncias grandes do Jenkins, tornando sua configuração versionável e testável.

Atualizações

O Jenkins é frequentemente atualizado, então sempre verifique as notas de versão e assegure-se de que sua versão é compatível com a versão suportada do Jenkins.

Visualização

Pense no Jenkins como uma tela (🖼️), seguramente trancada em um cofre (🔒). Você deseja adicionar cores às suas tarefas usando HTML, mas o Jenkins impõe medidas de segurança. Ele limita os tipos de formatação (cores) que você pode usar.

Seu kit de ferramentas:
- Lápis (✏️) = Texto simples
- Guache (🖌️) = HTML limitado
- Tinta a óleo (🛢️) = HTML completo (mas o Jenkins intervém: "Não, isso é muito arriscado")

Na tela das descrições do Jenkins:
- 🖼️✏️: "Use texto simples para descrições"
- 🖼️🖌️: "Incorpore HTML básico para formatação estilizada"
- 🖼️🚫🛢️: "Use HTML complexo, JS ou CSS fora do Jenkins"

Dê vida às suas tarefas usando HTML limitado para transformar descrições em verdadeiras obras de arte!

Dicas e Armadilhas

Usar HTML nas descrições de jobs do Jenkins pode apresentar desafios, mas vamos ajudá-lo a navegar por eles:

Destaque de Sintaxe

Ao habilitar HTML, certifique-se de que o parâmetro disableSyntaxHighLighting está definido como false nas configurações do Jenkins. Isso melhorará a legibilidade do código.

// Afinal, o destaque de sintaxe torna o código mais atraente, não é?

Navegação através de Links

Os links internos fornecidos pelo Jenkins ao configurar configurações de segurança são extremamente úteis. Use-os para evitar erros.

// Não hesite em clicar nesses links azuis - eles só ajudarão

Uso Seguro do HTML

Antes de começar, garanta que seu HTML não inclua elementos ativos como JavaScript ou CSS complexos. Seja cauteloso quanto à segurança e não exponha o Jenkins a riscos de ataque.

// Priorize a segurança. O Jenkins valoriza código seguro, talvez até mais que um café da manhã.

Recursos Úteis

1. GitHub - jenkinsci/antisamy-markup-formatter-plugin — Fonte de informação e documentação para o formatter Safe HTML.
2. OWASP Markup Formatter | Plugin do Jenkins — Tudo que você precisa saber sobre como configurar e usar o plugin.
3. Configurando a Política de Segurança de Conteúdo — Instruções para configurar o Jenkins para exibição segura de HTML.
4. DZone: Adicionando Emblemas Personalizados aos Jobs do Jenkins — Aprimorando as descrições dos jobs do Jenkins com emblemas para melhor percepção visual.
5. Documentação do Plugin no GitHub — Abordagem do Jenkins para configuração usando CSS e JavaScript.
6. Imagem Oficial do Jenkins para Docker — Teste as configurações do Jenkins localmente no Docker.

Video

Navigation