Skip to main content
Мы публикуем частые обновления нашей документации, и перевод этой страницы может все еще выполняться. Актуальные сведения см. в документации на английском языке.

Создание составного действия

В этом руководстве приведены инструкции по созданию составного действия.

Введение

В этом руководстве вы узнаете об основных компонентах, необходимых для создания и использования упакованного составного действия. Чтобы сосредоточиться в этом руководстве на компонентах, необходимых для пакета действия, функциональность кода действия будет минимальна. Действие выведет текст Hello World, а затем — Goodbye, или, если вы укажете пользовательское имя, оно выведет Hello [who-to-greet], а затем — Goodbye. Действие также сопоставляет случайное число с выходной переменной random-number и запускает сценарий с именем goodbye.sh.

Завершив этот проект, вы узнаете, как создать собственное составное действие и протестировать его в рабочем процессе.

Предупреждение. Во время создания рабочих процессов и действий необходимо учитывать, будет ли код использовать непроверенные входные данные от возможных злоумышленников. Некоторые контексты следует считать непроверенными, так как злоумышленники могут вставить собственное вредоносное содержимое. Дополнительные сведения см. в разделе "Основные сведения о риске вставки данных в скрипты".

Предварительные требования

Прежде чем начать, создайте репозиторий в GitHub.com.

  1. Создайте общедоступный репозиторий в GitHub.com. Вы можете выбрать любое имя репозитория или использовать следующий пример: hello-world-composite-action. Эти файлы можно добавить после отправки проекта в GitHub. Дополнительные сведения см. в статье Создание репозитория.

  2. Клонируйте репозиторий на ваш компьютер. Дополнительные сведения см. в разделе Клонирование репозитория.

  3. В окне терминала перейдите в новый репозиторий.

    cd hello-world-composite-action
  4. В репозитории hello-world-composite-action создайте файл под названием goodbye.sh и добавьте следующий пример кода:

    echo "Goodbye"
    
  5. В окне терминала сделайте goodbye.sh исполняемым файлом.

    chmod +x goodbye.sh
  6. В окне терминала зарегистрируйте файл goodbye.sh.

    git add goodbye.sh
    git commit -m "Add goodbye script"
    git push

Создание файла метаданных действия

  1. В репозитории hello-world-composite-action создайте файл под названием action.yml и добавьте следующий пример кода. Дополнительные сведения об этом синтаксисе см. в разделе runs для составных действий.

    **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 "random-number=$(echo $RANDOM)" >> $GITHUB_OUTPUT
          shell: bash
        - run: echo "${{ github.action_path }}" >> $GITHUB_PATH
          shell: bash
        - run: goodbye.sh
          shell: bash
    

    Этот файл определяет входные данные, сопоставляет who-to-greet случайно созданное число с random-number выходной переменной, добавляет путь действия в системный путь средства выполнения (для поиска скрипта goodbye.sh во время выполнения) и запускает goodbye.sh скрипт.

    Дополнительные сведения об управлении выходными данными см. в разделе outputs для составного действия.

    Дополнительные сведения об использовании github.action_path см. в разделе github context.

  2. В окне терминала зарегистрируйте файл action.yml.

    git add action.yml
    git commit -m "Add action"
    git push
  3. В окне терминала добавьте тег. В этом примере используется тег под названием v1. Дополнительные сведения см. в статье Сведения о действиях.

    git tag -a -m "Description of this release" v1
    git push --follow-tags

Тестирование действия в рабочем процессе

В следующем коде рабочего процесса используется завершенное действие hello world, выполненное в разделе Создание файла метаданных действия.

Скопируйте код рабочего процесса в файл .github/workflows/main.yml в другом репозитории, но замените actions/hello-world-composite-action@v1 репозиторием и тегом, который вы создали. Вы также можете заменить ввод who-to-greet своим именем.

.github/workflows/main.yml

on: [push]

jobs:
  hello_world_job:
    runs-on: ubuntu-latest
    name: A job to say hello
    steps:
      - uses: actions/checkout@v3
      - 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

В репозитории перейдите на вкладку Actions (Действия) и выберите последний запуск рабочего процесса. Выходные данные должны включать: Hello Mona the Octocat, результат сценария Goodbye и случайное число.