GitHub Actions надає потужний інструмент автоматизації робочих процесів в рамках репозиторіїв. Хоча існує багато готових публічних дій, іноді вам може знадобитися створити власну кастомну дію для специфічних завдань вашого проекту. Створення власних дій дає змогу впроваджувати спеціалізовану логіку, яка відповідає вашим потребам.

Типи кастомних дій

1. Composite Actions:
   • Composite Actions дозволяють об'єднувати кілька кроків (steps) в один пакет, який можна використовувати у різних робочих процесах. Це зручно для повторного використання загальних дій у різних частинах ваших проєктів.
2. JavaScript Actions:
   • Це дії, де основна логіка написана на JavaScript. Ви можете використовувати всі можливості Node.js, щоб реалізувати бажану поведінку дії. Цей тип дій підходить, якщо ви добре знаєте JavaScript.
3. Docker Actions:
   • Docker Actions запускають код у контейнерах Docker, що дозволяє використовувати будь-яку мову програмування та будь-які специфічні налаштування середовища. Цей підхід дає більше контролю над середовищем виконання.

Створення Composite Actions

1. Структура папок:

   • Створіть папку .github/actions у вашому репозиторії.
   • В цій папці створіть підпапку для вашої дії, наприклад my-action.

2. Файл action.yml:

   • Створіть файл action.yml в папці вашої дії. Цей файл містить метадані та конфігурацію для дії.

   • Приклад:

     name: "Get & Cache Dependencies"
     description: "Get dependencies and cache them using npm"
     runs:
       using: "composite"
       steps:
         - name: "Cache dependencies"
           uses: "actions/cache@v2"
           with:
             path: "~/.npm"
             key: ${{ runner.os }}-npm-cache-${{ hashFiles('**/package-lock.json') }}
         - name: "Install dependencies"
           run: "npm install"
           shell: "bash"
     
     

3. Використання Composite Actions:

   • У робочих процесах ви можете використовувати свою Composite Action так само, як і будь-яку іншу дію.

   • Приклад:

     jobs:
       build:
         runs-on: ubuntu-latest
         steps:
           - name: Checkout code
             uses: actions/checkout@v2
     
           - name: Use custom action
             uses: ./.github/actions/my-action
     
     

Створення JavaScript Actions

1. Структура проекту:

   • Створіть окрему папку для JavaScript дії, наприклад js-action.
   • В цій папці створіть файл action.yml.

2. Файл action.yml:

   • Приклад:

     name: "Hello World"
     description: "Says hello"
     runs:
       using: "node12"
       main: "index.js"
     
     

3. Логіка дії (файл index.js):

   • Напишіть код JavaScript для виконання вашої дії.

   • Приклад:

     const core = require('@actions/core');
     
     try {
       const name = core.getInput('name');
       console.log(`Hello, ${name}!`);
     } catch (error) {
       core.setFailed(error.message);
     }
     
     

4. Використання JavaScript Actions:

   • Приклад:

     jobs:
       greet:
         runs-on: ubuntu-latest
         steps:
           - name: Checkout code
             uses: actions/checkout@v2
     
           - name: Greet user
             uses: ./js-action
             with:
               name: "World"
     
     

Створення Docker Actions

1. Структура проекту:

   • Створіть окрему папку для Docker дії, наприклад docker-action.
   • В цій папці створіть файл action.yml.

2. Файл action.yml:

   • Приклад:

     name: "Docker Action Example"
     description: "An example Docker action"
     runs:
       using: "docker"
       image: "Dockerfile"
     
     

3. Dockerfile:

   • Опишіть середовище виконання та логіку вашої дії у Dockerfile.

   • Приклад:

     FROM node:14
     
     WORKDIR /app
     COPY entrypoint.sh /entrypoint.sh
     RUN chmod +x /entrypoint.sh
     
     ENTRYPOINT ["/entrypoint.sh"]
     
     

4. Логіка дії (файл entrypoint.sh):

   • Напишіть код, що виконує вашу дію.

   • Приклад:

     #!/bin/bash
     echo "Hello from Docker action!"