act README

The project's README from github.com/nektos/act. As one markdown file: README.md.

act-logo

Overview push Go Report Card awesome-runners

"Think globally, act locally"

Run your GitHub Actions locally! Why would you want to do this? Two reasons:

[!TIP] Now Manage and Run Act Directly From VS Code!
Check out the GitHub Local Actions Visual Studio Code extension which allows you to leverage the power of act to run and test workflows locally without leaving your editor.

How Does It Work?

When you run act it reads in your GitHub Actions from .github/workflows/ and determines the set of actions that need to be run. It uses the Docker API to either pull or build the necessary images, as defined in your workflow files and finally determines the execution path based on the dependencies that were defined. Once it has the execution path, it then uses the Docker API to run containers for each action based on the images prepared earlier. The environment variables and filesystem are all configured to match what GitHub provides.

Let's see it in action with a sample repo!

Demo

Act User Guide

Please look at the act user guide for more documentation.

Support

Need help? Ask in discussions!

Contributing

Want to contribute to act? Awesome! Check out the contributing guidelines to get involved.

Manually building from source

act (nektos/act)

Searching Database…

72.4K ·GitHub
Что это такое?act позволяет запускать воркфлоу GitHub Actions локально, не отправляя изменения в GitHub каждый раз, чтобы проверить правки в .github/workflows.
Это инструмент командной строки или что-то другое?Это инструмент командной строки (написанный на Go), у которого также есть неофициальное расширение для VS Code, позволяющее запускать его из редактора.
Как его запустить?Установите бинарный файл act, затем запустите его внутри репозитория, в котором есть папка .github/workflows; он читает файлы воркфлоу и выполняет их.
Нужно ли сначала установить Docker?Да, act использует Docker API, чтобы загрузить или собрать образы, указанные в ваших файлах воркфлоу, и запускать каждое действие в отдельном контейнере.
Полностью ли он воспроизводит настоящую среду выполнения GitHub?Прямо об этом не сказано, кроме того что act настраивает переменные окружения и файловую систему так, чтобы они совпадали с GitHub. Но действия запускаются в локальных контейнерах Docker, а не на размещённых раннерах GitHub, поэтому в нестандартных случаях поведение может отличаться.
Кому это полезно?Разработчикам, которые хотят быстро получать обратную связь по изменениям воркфлоу без коммита и пуша каждый раз, или которые хотят использовать определения GitHub Actions как локальный раннер задач вместо Makefile.
Может ли act полностью заменить мой Makefile?Да, автор предлагает использовать уже определённые в .github/workflows/ GitHub Actions как локальный раннер задач вместо поддержки отдельного Makefile.
Creator
nektos
Size
17.3 MB
Stars
72.4K
Age
7y
Commits · 90 Days