Observação: Executores hospedados em GitHub não são atualmente compatíveis com GitHub Enterprise Server. Você pode ver mais informações sobre suporte futuro planejado no Itinerário público do GitHub.
Introdução
Neste guia, você aprenderá os componentes básicos necessários para criar e usar uma ação composta empacotada. Para manter o foco deste guia nos componentes necessários para empacotar a ação, a funcionalidade do código da ação é mínima. A ação imprime "Hello World" e "Goodbye", ou, se você fornecer um nome personalizado, imprimirá "Hello [who-to-greet]" e "Goodbye". A ação também mapeia um número aleatório para a variável de saída random-number
e executa um script denominado goodbye.sh
.
Ao concluir este projeto, você entenderá como criar a sua própria ação composta e testá-la em um fluxo de trabalho.
Aviso: Ao criar fluxos de trabalho e ações, você sempre deve considerar se seu código pode executar entradas não confiáveis de possíveis invasores. Certos contextos devem ser tratados como entradas não confiáveis, uma vez que um invasor pode inserir seu próprio conteúdo malicioso. Para obter mais informações, consulte "Entender o risco de injeções de scripts".
Pré-requisitos
Antes de começar, você criará um repositório em your GitHub Enterprise Server instance.
-
Crie um repositório público novo no your GitHub Enterprise Server instance. Você pode escolher qualquer nome de repositório ou usar o exemplo
hello-world-composite-action
. É possível adicionar esses arquivos após push do projeto no GitHub Enterprise Server. Para obter mais informações, consulte "Criar um repositório novo". -
Clone o repositório para seu computador. Para obter mais informações, consulte "Clonar um repositório".
-
No seu terminal, mude os diretórios para seu novo repositório.
cd hello-world-composite-action
-
No repositório
hello-world-composite-action
, crie um novo arquivo denominadogoodbye.sh
e adicione o seguinte código de exemplo:echo "Goodbye"
-
No seu terminal, torne
goodbye.sh
executável.chmod +x goodbye.sh
-
No terminal, verifique no seu arquivo
goodbye.sh
.git add goodbye.sh git commit -m "Add goodbye script" git push
Criar um arquivo de metadados de ação
-
No repositório
hello-world-composite-action
, crie um novo arquivo denominadoaction.yml
e adicione o código de exemplo a seguir. Para obter mais informações sobre essa sintaxe, consulte "executa
para uma ação composta".action.yml
name: 'Hello World' description: 'Greet someone' inputs: who-to-greet: # id of input description: 'Who to greet' required: true default: 'World' outputs: random-number: description: "Random number" value: ${{ steps.random-number-generator.outputs.random-number }} runs: using: "composite" steps: - run: echo Hello ${{ inputs.who-to-greet }}. shell: bash - id: random-number-generator run: echo "::set-output name=random-number::$(echo $RANDOM)" shell: bash - run: echo "${{ github.action_path }}" >> $GITHUB_PATH shell: bash - run: goodbye.sh shell: bash
Este arquivo define a entrada de
who-to-greet
, mapeia o número aleatório gerado para a variável de saídarandom-number
e executa o scriptgoodbye.sh
. Também informa ao executor como executar a ação composta.Para obter mais informações sobre o gerenciamento de saídas, consulte "
outputs
para uma ação composta.Para obter mais informações sobre como usar
github.action_path
, consulte "github context
". -
No seu terminal, verifique o seu arquivo
action.yml
.git add action.yml git commit -m "Add action" git push
-
No seu terminal, adicione uma tag. Este exemplo usa uma tag denominada
v1
. Para obter mais informações, consulte "Sobre ações".git tag -a -m "Description of this release" v1 git push --follow-tags
Testar sua ação em um fluxo de trabalho
O código de fluxo de trabalho a seguir usa a ação hello world completa que você fez em "Criando uma ação arquivo de metadados".
Copie o código do fluxo de trabalho em um arquivo .github/workflows/main.yml
em outro repositório, mas substitua actions/hello-world-composite-action@v1
pelo repositório e pela tag que você criou. Você também pode substituir a entrada who-to-greet
pelo seu nome.
.github/workflows/main.yml
on: [push]
jobs:
hello_world_job:
runs-on: ubuntu-latest
name: A job to say hello
steps:
- uses: actions/checkout@v2
- id: foo
uses: actions/hello-world-composite-action@v1
with:
who-to-greet: 'Mona the Octocat'
- run: echo random-number ${{ steps.foo.outputs.random-number }}
shell: bash
No seu repositório, clique na aba Ações e selecione a última execução do fluxo de trabalho. A saída deve incluir: "Hello Mona the Octocat", o resultado do script "Goodbye" e um número aleatório.