Краткое руководство по GitHub Actions

Введение

GitHub Actions — это платформа непрерывной интеграции и непрерывной поставки (CI/CD), которая позволяет автоматизировать конвейер сборки, тестирования и развертывания. Рабочие процессы, выполняющие тесты, можно создавать всякий раз, когда вы отправляете изменения в репозиторий или развертываете объединенные запросы на вытягивание в рабочую среду.

В этом кратком руководстве показано, как использовать пользовательский интерфейс ваш экземпляр GitHub Enterprise Server для добавления рабочего процесса, демонстрирующего некоторые основные функции GitHub Actions.

Чтобы приступить к работе с предварительно настроенными рабочими процессами, просмотрите список шаблонов в репозитории actions/starter-workflows в репозитории ваш экземпляр GitHub Enterprise Server. Дополнительные сведения см. в разделе Использование шаблонов рабочих процессов.

Общие сведения о рабочих процессах GitHub Actions см. в разделе "Сведения о рабочих процессах". Если вы хотите узнать о различных компонентах, составляющих GitHub Actions, см. раздел "Общие сведения о GitHub Actions".

Использование шаблонов рабочих процессов

GitHub предоставляет предварительно настроенные шаблоны рабочих процессов, которые можно использовать как есть или настроить для создания собственного рабочего процесса. GitHub Enterprise Server анализирует код и показывает шаблоны рабочих процессов, которые могут быть полезны для репозитория. Например, если репозиторий содержит код Node.js, вы увидите предложения для проектов Node.js.

Эти шаблоны рабочих процессов предназначены для быстрого и быстрого запуска, предлагая ряд конфигураций, таких как:

• CI: рабочие процессы непрерывной интеграции
• Развертывания: рабочие процессы развертывания
• Автоматизация: автоматизация рабочих процессов
• Сканирование кода: рабочие процессы сканирования кода
• Страницы: рабочие процессы страниц

Используйте эти рабочие процессы в качестве отправного места для создания пользовательского рабочего процесса или их использования как есть. Полный список шаблонов рабочих процессов можно просмотреть в репозитории actions/starter-workflows на ваш экземпляр GitHub Enterprise Server. Дополнительные сведения см. в разделе Использование шаблонов рабочих процессов.

Необходимые компоненты

В этом руководстве предполагается, что:

• У вас есть по крайней мере базовые знания об использовании GitHub. Если вы этого не сделали, вам будет полезно сначала ознакомиться с некоторыми статьями в документации по репозиториям и запросам на вытягивание. Например, см. раздел[ "AUTOTITLE", "Краткое руководство по репозиториям" и "Сведения о запросах на вытягивание](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches)".

• У вас есть репозиторий на ваш экземпляр GitHub Enterprise Server, где можно добавлять файлы.

• У вас есть доступ к GitHub Actions.

  Note

  Если вкладка "Play" aria-hidden="true" Actions не отображается под именем репозитория на GitHub, это может быть вызвано отключением действий для репозитория. Дополнительные сведения см. в разделе Управление параметрами GitHub Actions для репозитория.

Создание вашего первого рабочего процесса

1. В репозитории на ваш экземпляр GitHub Enterprise Serverсоздайте файл рабочего процесса, вызываемого github-actions-demo.yml в каталоге .github/workflows . Для этого:

   • .github/workflows Если каталог уже существует, перейдите к этому каталогу на GitHub, нажмите кнопку "Добавить файл", а затем нажмите кнопку "Создать файл" и назовите файлgithub-actions-demo.yml.

   • Если в репозитории нет .github/workflows каталога, перейдите на главную страницу репозитория на GitHub, нажмите кнопку "Добавить файл", а затем нажмите кнопку "Создать файл" и назовите файл.github/workflows/github-actions-demo.yml. Это создает .github каталоги и workflows github-actions-demo.yml файлы на одном шаге.

   Note

   Для GitHub для обнаружения любых рабочих процессов GitHub Actions в репозитории необходимо сохранить файлы рабочего процесса в каталоге .github/workflows.

   Вы можете присвоить файлу рабочего процесса любое имя, но необходимо использовать .yml или .yaml в качестве расширения имени файла. YAML — это язык разметки, который часто используется для файлов конфигурации.

2. Скопируйте в файл следующее содержимое github-actions-demo.yml YAML:

   YAML

   name: GitHub Actions Demo
   run-name: ${{ github.actor }} is testing out GitHub Actions 🚀
   on: [push]
   jobs:
     Explore-GitHub-Actions:
       runs-on: ubuntu-latest
       steps:
         - run: echo "🎉 The job was automatically triggered by a ${{ github.event_name }} event."
         - run: echo "🐧 This job is now running on a ${{ runner.os }} server hosted by GitHub!"
         - run: echo "🔎 The name of your branch is ${{ github.ref }} and your repository is ${{ github.repository }}."
         - name: Check out repository code
           uses: actions/checkout@v4
         - run: echo "💡 The ${{ github.repository }} repository has been cloned to the runner."
         - run: echo "🖥️ The workflow is now ready to test your code on the runner."
         - name: List files in the repository
           run: |
             ls ${{ github.workspace }}
         - run: echo "🍏 This job's status is ${{ job.status }}."
   

   На этом этапе вам не нужно понимать подробности этого рабочего процесса. Теперь вы можете просто скопировать и вставить содержимое в файл. После выполнения этого краткого руководства вы можете узнать о синтаксисе файлов рабочих процессов в[ autoTITLE, а также объяснить контексты GitHub Actions ( например${{ github.actor }}``${{ github.event_name }}, autoTITLE).](/actions/learn-github-actions/contexts)

3. Щелкните Зафиксировать изменения.

4. В диалоговом окне "Предложение изменений" выберите вариант фиксации в ветвь по умолчанию или параметр для создания новой ветви и запуска запроса на вытягивание. Затем нажмите кнопку "Зафиксировать изменения " или " Предложить изменения".

   

Фиксация файла рабочего процесса в ветви в вашем репозитории активирует событие push и запускает рабочий процесс.

Если вы решили запустить запрос на вытягивание, вы можете продолжить и создать запрос на вытягивание, но это необязательно для целей этого краткого руководства, так как фиксация по-прежнему была выполнена в ветви и активирует новый рабочий процесс.

Просмотр результатов рабочего процесса

1. На GitHubперейдите на главную страницу репозитория.

2. Под именем репозитория щелкните Actions.

   

3. На левой боковой панели щелкните рабочий процесс, который вы хотите отобразить, в этом примере "GitHub Actions Demo".

   

4. В списке запусков рабочих процессов щелкните имя запуска, которое вы хотите увидеть, в этом примере "ИМЯ ПОЛЬЗОВАТЕЛЯ тестирует GitHub Actions".

5. На левой боковой панели страницы запуска рабочего процесса в разделе "Задания" щелкните задание "Обзор-GitHub-Actions ".

   

6. В журнале показано, как был обработан каждый из шагов. Чтобы просмотреть сведения о шаге, разверните его.

   

   Например, можно просмотреть список файлов в репозитории:

   

Пример рабочего процесса, который вы только что добавили, активируется каждый раз, когда код отправляется в ветвь, и показывает, как GitHub Actions может работать с содержимым репозитория. Подробное руководство см. в разделе "Общие сведения о GitHub Actions".

Следующие шаги

GitHub Actions помогает автоматизировать практически все аспекты процессов разработки приложений. Готовы приступить к работе? Далее приведены некоторые полезные ресурсы для выполнения следующих этапов работы с GitHub Actions.

• Сведения о создании рабочего процесса GitHub Actions см. в разделе "Использование шаблонов рабочих процессов".
• Сведения о рабочих процессах непрерывной интеграции (CI) см. в разделе "Создание и тестирование".
• Сведения о создании и публикации пакетов см. в разделе "Публикация пакетов".
• Сведения о развертывании проектов см. в разделе "Варианты использования и примеры".
• Сведения об автоматизации задач и процессов в GitHubсм. в разделе "Управление проектами".
• Примеры, демонстрирующие более сложные функции GitHub Actions, см. в разделе "Варианты использования и примеры". В этих подробных примерах объясняется, как протестировать код в средстве выполнения, получить доступ к GitHub CLI и использовать дополнительные функции, такие как параллелизм и матрицы тестов.