Введение. GitHub Actions — это мощный инструмент для автоматизации рабочих процессов и задач в ваших проектах разработки программного обеспечения. С помощью Actions вы можете легко создавать, тестировать и развертывать свой код. В этой записи блога мы познакомим вас с процессом создания многократно используемого действия JavaScript GitHub на примере действия update-github-action-secret. Изучив код и структуру общедоступного репозитория GitHub (https://github.com/NikhilVashistha/update-github-action-secret), вы получите четкое представление о том, как создавать собственные настраиваемые действия для оптимизации процесса разработки.

Предварительные требования. Прежде чем мы углубимся в создание действия GitHub JavaScript, убедитесь, что у вас выполнены следующие предварительные условия:

  1. Базовое понимание JavaScript и Действий GitHub.
  2. Аккаунт GitHub.
  3. Знакомство с концепциями Git и управления версиями.
  4. Node.js и npm (диспетчер пакетов Node), установленные на вашем локальном компьютере.

Шаг 1. Настройка локальной среды. Для начала создайте новый каталог на локальном компьютере для своего проекта GitHub Action. Откройте терминал или командную строку, перейдите в каталог проекта и инициализируйте новый проект Node.js, выполнив следующую команду:

$ npm init -y

Это создаст файл package.json для вашего проекта, который позволит вам управлять зависимостями и сценариями.

Шаг 2. Установка зависимостей Далее нам нужно установить необходимые зависимости для нашего действия GitHub. В этом примере мы будем использовать пакет @actions/core, который предоставляет набор инструментов для работы с GitHub Actions. Выполните следующую команду, чтобы установить его:

$ npm install @actions/core

Шаг 3. Клонирование репозитория-примера Чтобы понять структуру и реализацию действия GitHub "update-github-action-secret", клонируйте репозиторий-пример из GitHub, выполнив в терминале следующую команду:

$ git clone https://github.com/NikhilVashistha/update-github-action-secret

Это создаст локальную копию репозитория на вашем компьютере.

Шаг 4. Проверка кода действия Перейдите в каталог клонированного репозитория и откройте файл index.js в редакторе кода. Потратьте время, чтобы просмотреть код и понять, как он работает. Это даст вам ценную информацию о создании собственных действий GitHub.

Шаг 5. Понимание метаданных действий В репозитории вы найдете файл action.yml. Откройте его в редакторе кода, чтобы изучить метаданные для действия. Этот файл YAML определяет имя, описание, входы, выходы и детали выполнения действия. Внимательно изучите его, чтобы понять, как устроен пример Action.

Шаг 6. Изменение и настройка действия Теперь, когда у вас есть четкое представление о примере действия, вы можете изменить и настроить его в соответствии со своими конкретными требованиями. Не стесняйтесь обновлять код, метаданные и любые другие соответствующие файлы, чтобы привести их в соответствие с желаемой функциональностью.

Шаг 7. Фиксация и отправка пользовательского действия После внесения необходимых изменений в пример действия пришло время зафиксировать и отправить код в репозиторий GitHub. Создайте новый репозиторий на GitHub, инициализируйте новый репозиторий Git локально, добавьте необходимые файлы и отправьте код в удаленный репозиторий.

Шаг 8. Использование пользовательского действия в рабочем процессе Чтобы использовать только что созданное действие в рабочем процессе GitHub, перейдите в свой репозиторий на GitHub и создайте новый файл рабочего процесса (например, .github/workflows/main.yml). При необходимости определите рабочий процесс и добавьте шаг, который ссылается на ваше пользовательское действие. Например:

- name: Update Secret
  uses: your-username/your-repository-name@main
  with:
    secret_value: ${{ secrets.YOUR_SECRET_NAME }}

Замените your-username и your-repository-name своим именем пользователя GitHub и именем репозитория соответственно. Кроме того, обновите YOUR_SECRET_NAME, указав фактическое имя секрета, который вы хотите обновить.

Шаг 9. Зафиксируйте и запустите рабочий процесс Зафиксируйте и отправьте файл рабочего процесса в свой репозиторий. GitHub автоматически запускает рабочий процесс всякий раз, когда изменения отправляются в репозиторий. Вы также можете вручную запустить рабочий процесс на вкладке «Действия» в вашем репозитории.

Вывод: Поздравляем! Вы успешно создали многоразовое действие JavaScript GitHub, изучив пример репозитория update-github-action-secret. Поняв код и структуру существующего действия, вы теперь обладаете знаниями и уверенностью для создания собственных настраиваемых действий для автоматизации и оптимизации процессов разработки. Действия GitHub предоставляют безграничные возможности для улучшения вашего рабочего процесса разработки программного обеспечения, и с вашими новыми навыками вы можете максимально использовать этот мощный инструмент. Удачной автоматизации!