====== Arquivo de configuração do projeto ======

===== Objetivo =====

Este artigo serve para mostrar como parametrizar um ou mais arquivos de configuração dentro do projeto no Jenkins. O principal benefício desta configuração é que dois jobs podem ser criados, mas dependendo do local aonde o projeto será hospedado possua configurações diferentes

===== Módulo necessário =====

Para que possamos ter o arquivo de configuração variável por projeto, devemos ter os seguintes plugins instalados no Jenkins:

  * Config File Provider Plugin
  * Credentials
  * SSH Credentials
  * Structs
  * Token Macro

===== Configurando arquivo no JOB =====

==== Criando o arquivo de configuração ====

A criação do arquivo de configuração é feita através do menu **Jenkins > Gerenciar Jenkins > Managed Files** ((https://plugins.jenkins.io/config-file-provider)). A seguinte tela será apresentada:

 {{ :jenkins:jenkins_managed_files1.png?400 | Tela com os arquivos de configuração cadastrados no jenkins. }}

Vamos agora executar o passo para cadastrar um novo arquivo de configuração. Para isso selecionamos o menu **Add a New Config**. A próxima tela será mostrada. Nela é possível selecionar o tipo de arquivo que será cadastrado, como arquivos %%pom.xml%%, arquivos yml, xml, json etc.; ou arquivos customizados.

Depois de selecionado o tipo de arquivo, é preciso dar um ID a ele. O plugin apresenta um ID gerado automaticamente, mas você pode alterar da forma que achar melhor. 

{{ :jenkins:selecionando_arquivo_configuracao.png?direct&400 | Lista com os arquivos selecionados. Pode-se criar um novo.}}

Ao selecionar o cadastro do novo arquivo aparece uma tela com 4 campos: 

  * ID do arquivo
  * Nome do arquivo, que aparecerá na hora de selecionar o arquivo no JOB.
  * Descrição, que aparecerá na hora de visualizar os arquivos cadastrados. 
  * Conteúdo.

Depois que você inserir o conteúdo, basta salvar a alteração que o novo arquivo será criado.

{{ :jenkins:descricao_arquivo.png?direct&400 | Formulário de cadastro do novo arquivo.}}

==== Informando o arquivo no JOB ====

Uma vez o cadastro do arquivo realizado, precisamos associá-lo no JOB. Então, vá até o JOB cadastrado e selecione o menu **Configurar**.

Navegue até a aba **Ambiente de Build** e habilite a opção //Provide Configuration files//.
{{ :jenkins:ambiente_build.png?direct&400 | Inserindo arquivo de ambiente de build.}}

Os campos existentes são:
  - Arquivo de configuração selecionado. A lista apresentará todos os arquivos existentes no cadastro.
  - Target: endereço e nome que o arquivo receberá no projeto. O nome deve ser relativo ao workspace do job.
  - Variable: Indica se alguma variável do arquivo se tornará variável de ambiente.
  - Replate Tokens: Reescreve um token dentro do arquivo. Nunca é aconselhável mudar.

Ainda sobre o campo target, se já existir o arquivo no projeto o mesmo será substituído pelo arquivo com o conteúdo cadastrado no Jenkins.