Skip to content

Commit 91bbcad

Browse files
committed
add Local GitHub Action testing to README
1 parent 725e257 commit 91bbcad

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

README.md

+16-1
Original file line numberDiff line numberDiff line change
@@ -206,7 +206,7 @@ purpose. This is useful for a few reasons:
206206
talking to a bot instead of a human.
207207
- It makes it easy to audit our automations in the future, because all commits
208208
and messages will be associated with the single @cc-open-source-bot user
209-
account via the GitHub search, api, etc.
209+
account via the GitHub search, api, etc.
210210
- We won't need to update automations when there are changes to staff or
211211
volunteers.
212212

@@ -247,6 +247,21 @@ GitHub Action:
247247
[requests]: https://requests.readthedocs.io/en/latest/
248248
249249
250+
## Local GitHub Action testing
251+
252+
The GitHub Actions can be tested locally using:
253+
- [nektos/act](https://github.com/nektos/act): _Run your GitHub Actions locally
254+
🚀_
255+
256+
On ARM laptops (ex. M1 MacBook Pros), there may not be docker images available.
257+
You may have to specify the linux/amd64 architecture. For example:
258+
```shell
259+
act --secret ADMIN_GITHUB_TOKEN --container-architecture linux/amd64 --rm \
260+
--job manage_issues_and_pull_requests
261+
```
262+
(this assumes that the `ADMIN_GITHUB_TOKEN` environment variable has been set)
263+
264+
250265
## License
251266

252267
- [`LICENSE`](LICENSE) (Expat/[MIT][mit] License)

0 commit comments

Comments
 (0)