tschoffelen/gha
1
1
Fork 0
mirror of https://github.com/tschoffelen/gha.git synced 2024-10-05 21:38:21 +03:00
Code Issues Projects Releases Wiki Activity

Improved README

Browse Source
This commit is contained in:
Thomas Schoffelen 2018-12-31 19:23:49 +01:00
parent b8de93fb96
commit b83dc4f57a
No known key found for this signature in database
GPG Key ID: 03F5C979F442A38D
1 changed files with 26 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@ -6,14 +6,20 @@ your GitHub workflow locally using Docker.
## Installation
Install using [NPM](https://npmjs.com):
Install using [NPM](https://npmjs.com/):
```
npm i -g gha
```
Other prerequisites:
### Usage
* A local installation of [Docker](https://docker.com/)
* A repo with a `.github/main.workflow` file
## Usage
```
Usage: gha [options]
@ -24,3 +30,21 @@ Options:
-e <event> Set event, defaults to push
-h, --help output usage information
```
## Development
This app currently only supports Github-hosted Dockerfiles (i.e. with the
`{user}/{repo}@{ref}` or `{user}/{repo}/{path}@{ref}` syntax), so we still need
to add:
- [ ] Add support for local Docker images: [`./path/to/dir`](https://developer.github.com/actions/creating-workflows/workflow-configuration-options/#using-a-dockerfile-image-in-an-action)
- [ ] Add support for Docker Hub images: [`docker://{image}:{tag}`](https://developer.github.com/actions/creating-workflows/workflow-configuration-options/#using-a-dockerfile-image-in-an-action)
- [ ] Add support for custom hosted Docker images: [`docker://{host}/{image}:{tag}`](https://developer.github.com/actions/creating-workflows/workflow-configuration-options/#using-a-dockerfile-image-in-an-action)
Some improvements are also possible in other areas:
- [ ] Add support for [secrets](https://developer.github.com/actions/creating-workflows/storing-secrets/)
- [ ] Add support for default [`GITHUB_TOKEN`](https://developer.github.com/actions/creating-workflows/storing-secrets/#github-token-secret) env var
- [ ] Add [`/github/home`](https://developer.github.com/actions/creating-github-actions/accessing-the-runtime-environment/#filesystem) volume that should exist by default
- [ ] Add file [`/github/workflow/event.json`](https://developer.github.com/actions/creating-github-actions/accessing-the-runtime-environment/#filesystem) that should exist by default