GitHub Actions надає потужні можливості для автоматизації різних процесів, і однією з найцінніших функцій є можливість створювати кастомні (користувацькі) дії (actions), які можна використовувати не лише в одному проєкті, але й у різних репозиторіях, а також ділитися ними з іншими користувачами через GitHub Marketplace.
Збереження кастомних Actions у окремих репозиторіях
Якщо ви створили кастомну дію, яку хочете використовувати в різних проєктах або репозиторіях, найкращою практикою є збереження цієї дії в окремому репозиторії. Це дозволяє легко керувати оновленнями дії, а також використовувати її в будь-якому іншому проєкті, просто посилаючись на відповідний репозиторій.
Кроки для збереження кастомних Actions у окремих репозиторіях:
- Створіть новий репозиторій:
- Створіть новий GitHub репозиторій, де ви зберігатимете вашу кастомну дію.
- Додайте до репозиторію файл
action.yml
, який міститиме опис вашої дії, її вхідні дані та інструкції для виконання.
- Версування дій за допомогою тегів:
- Використовуйте Git теги для створення версій вашої дії. Це дозволяє користувачам вибирати, яку версію дії використовувати у своїх workflow.
- Для створення тега використовуйте команду
git tag -a v1 -m "Release version 1"
, після чого виконайте git push --tags
.
- Використання дій в інших проєктах:
-
Щоб використовувати збережену дію в іншому проєкті, просто додайте її до workflow наступним чином:
uses: username/repository-name@v1
Публікація Actions в GitHub Marketplace
Публікація вашої кастомної дії в GitHub Marketplace дозволяє іншим користувачам GitHub легко знаходити і використовувати вашу дію. Це корисно, якщо ви хочете поділитися своїми діями з іншими розробниками або організаціями.
Кроки для публікації в GitHub Marketplace:
- Підготовка репозиторію:
- Переконайтеся, що ваш репозиторій має читабельний
README.md
файл, який описує вашу дію, її можливості, приклади використання та будь-які необхідні вимоги.
- У
action.yml
файлі повинна бути детальна інформація про вхідні дані, вихідні дані, та інструкції з використання.
- Реєстрація дії в GitHub Marketplace:
- Перейдіть до налаштувань вашого репозиторію і знайдіть розділ "Actions".
- Натисніть на кнопку "Add to marketplace" та дотримуйтесь інструкцій для завершення публікації.
- Поширення та використання:
- Після публікації ваша дія стане доступною для пошуку і використання іншими користувачами GitHub. Вони зможуть додавати її до своїх workflow за допомогою команди
uses: username/repository-name@v1
.
Переваги збереження та поширення кастомних Actions:
- Повторне використання: Легке використання ваших дій у багатьох проєктах без потреби дублювання коду.
- Версування: Можливість контролювати версії дій, що забезпечує стабільність при використанні у великих проєктах.
- Спільний доступ: Публікація в GitHub Marketplace дозволяє іншим користувачам знаходити і використовувати ваші дії, що може допомогти спільноті та розширити ваш вплив як розробника.