p79813206
/
act
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
act/README.md

64 lines
3.3 KiB
Markdown
Raw Normal View History

readme update
2019-01-19 01:01:01 +08:00
![](https://github.com/nektos/act/wiki/img/logo-150.png)
readme update
2019-01-19 10:18:11 +08:00
# Overview [![Join the chat at https://gitter.im/nektos/act](https://badges.gitter.im/nektos/act.svg)](https://gitter.im/nektos/act?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![Go Report Card](https://goreportcard.com/badge/github.com/nektos/act)](https://goreportcard.com/report/github.com/nektos/act) [![Github All Releases](https://img.shields.io/github/downloads/nektos/act/total.svg?maxAge=604800)](https://github.com/nektos/act/releases)
readme update
2019-01-19 01:01:01 +08:00
> "Think globally, <code>act</code> locally"
Initial commit with support for GitHub actions
2019-01-13 12:45:25 +08:00
readme update
2019-01-19 00:28:09 +08:00
Update README.md Pretty minimal changes, I removed some extra spaces and corrected a typo in the "How Does It Work?" paragraph "the" -> "then".
2019-01-19 05:05:29 +08:00
Run your [GitHub Actions](https://developer.github.com/actions/) locally! Why would you want to do this? Two reasons:
Initial commit with support for GitHub actions
2019-01-13 12:45:25 +08:00
Update README.md Pretty minimal changes, I removed some extra spaces and corrected a typo in the "How Does It Work?" paragraph "the" -> "then".
2019-01-19 05:05:29 +08:00
* **Fast Feedback** - Rather than having to commit/push every time you want test out the changes you are making to your `main.workflow` file (or for any changes to embedded GitHub actions), you can use `act` to run the actions locally. The [environment variables](https://developer.github.com/actions/creating-github-actions/accessing-the-runtime-environment/#environment-variables) and [filesystem](https://developer.github.com/actions/creating-github-actions/accessing-the-runtime-environment/#filesystem) are all configured to match what GitHub provides.
* **Local Task Runner** - I love [make](https://en.wikipedia.org/wiki/Make_(software)). However, I also hate repeating myself. With `act`, you can use the GitHub Actions defined in your `main.workflow` file to replace your `Makefile`!
Initial commit with support for GitHub actions
2019-01-13 12:45:25 +08:00
# How Does It Work?
Update README.md Pretty minimal changes, I removed some extra spaces and corrected a typo in the "How Does It Work?" paragraph "the" -> "then".
2019-01-19 05:05:29 +08:00
When you run `act` it reads in your GitHub Actions from `.github/main.workflow` 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 `main.workflow` file 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](https://developer.github.com/actions/creating-github-actions/accessing-the-runtime-environment/#environment-variables) and [filesystem](https://developer.github.com/actions/creating-github-actions/accessing-the-runtime-environment/#filesystem) are all configured to match what GitHub provides.
Initial commit with support for GitHub actions
2019-01-13 12:45:25 +08:00
Let's see it in action with a [sample repo](https://github.com/cplee/github-actions-demo)!
![Demo](https://github.com/nektos/act/wiki/quickstart/act-quickstart.gif)
# Installation
To install with [Homebrew](https://brew.sh/), run:
```brew install nektos/tap/act```
Alternatively, you can use the following:
readme
2019-01-15 16:32:19 +08:00
```curl https://raw.githubusercontent.com/nektos/act/master/install.sh | sudo bash```
Initial commit with support for GitHub actions
2019-01-13 12:45:25 +08:00
# Commands
```
# List the actions
act -l
# Run the default (`push`) event:
act
# Run a specific event:
act pull-request
# Run a specific action:
fix #6 - update the example for running a specific action
2019-01-16 13:44:17 +08:00
act -a test
Initial commit with support for GitHub actions
2019-01-13 12:45:25 +08:00
# Run in dry-run mode:
act -n
add support for 'reuse' mode to allow act to be used for a fast local task runner
2019-01-17 16:45:37 +08:00
# Run in reuse mode to save state:
act -r
Initial commit with support for GitHub actions
2019-01-13 12:45:25 +08:00
```
# Support
Need help? Ask on [Gitter](https://gitter.im/nektos/act)!
# Contributing
Update README.md Pretty minimal changes, I removed some extra spaces and corrected a typo in the "How Does It Work?" paragraph "the" -> "then".
2019-01-19 05:05:29 +08:00
Want to contribute to act? Awesome! Check out the [contributing guidelines](CONTRIBUTING.md) to get involved.
Initial commit with support for GitHub actions
2019-01-13 12:45:25 +08:00
## Building from source
* Install Go tools 1.11+ - (https://golang.org/doc/install)
* Clone this repo `git clone git@github.com:nektos/act.git`
* Run unit tests with `make check`
Update README.md Pretty minimal changes, I removed some extra spaces and corrected a typo in the "How Does It Work?" paragraph "the" -> "then".
2019-01-19 05:05:29 +08:00
* Build and install: `make install`