Gitlab Project Variable
Resumo
- Criar, atualizar e excluir variáveis de projetos no Gitlab.
Parâmetros
Parâmetro | Tipo | Escolhas | Valor Padrão | Comentários |
|---|---|---|---|
api_token - required | string | | Token GitLab para login. |
api_url | string | | O caminho da API em formato URL. |
project - required | string | | O caminho e o nome do projeto. |
purge | boolean | Escolhas: - false (default) - true | Quando definido como verdadeiro, todas as variáveis que não são intocadas na tarefa serão excluídas. |
state | string | Escolhas: - present (default) - absent | Crie ou exclua a variável do projeto. Os valores possíveis são present e absent. |
validate_certs | boolean | Escolhas: - false - true (default) | Se deve ou não validar certificados SSL ao fornecer uma url https. |
vars | dictionary | Default: {} | Quando o elemento da lista é um par de valores-chave simples, mascarado e protegido será definido como falso. Quando o elemento da lista é um dicionário com o valor das chaves, mascarado e protegido, o usuário pode ter controle total sobre se um valor deve ser mascarado , protegido ou ambos. O suporte para valores protegidos requer GitLab> = 9.3. O suporte para valores mascarados requer GitLab> = 11.10. Um valor deve ser uma string ou um número. O campo variable_type deve ser uma string com env_var, que é o padrão, ou file.Field environment_scope deve ser uma string definida pelo ambiente de escopo. Quando um valor é mascarado, ele deve estar em Base64 e ter um comprimento de pelo menos 8 caracteres. Consulte a documentação do GitLab sobre valores aceitáveis para uma variável mascarada (https://docs.gitlab.com/ce/ci/variables/#masked-variables). |
Exemplos
# Exemplo: Definir ou atualizar algumas variáveis CI/CD
- gitlab_project_variable:
api_url: https://gitlab.com
api_token: access_token
project: myuser/project
purge: false
vars:
ACCESS_KEY_ID: abc123
SECRET_ACCESS_KEY: 321cba
# Exemplo: Excluir uma variável
- gitlab_project_variable:
api_url: https://gitlab.com
api_token: access_token
project: myuser/project
state: absent
vars:
ACCESS_KEY_ID: abc123
Valores retornados
Chave | Tipo | Retornado quando | Descrição |
|---|---|---|---|
project_variable | dictionary | Sempre | Quatro listas de nomes de variáveis que foram adicionados, atualizados, removidos ou existem. |
added | list / elements=string | Sempre | Uma lista de variáveis que foram criadas. |
removed | list / elements=string | Sempre | Uma lista de variáveis que foram excluídas. |
untouched | list / elements=string | Sempre | Uma lista de variáveis existentes. |
update | list / elements=string | Sempre | Uma lista de variáveis cujos valores foram alterados. |