Update README

This commit is contained in:
Adam Dobrawy 2019-08-24 14:02:50 +02:00
parent fbe6aa5e4b
commit e6fbd0f271

View File

@ -1,13 +1,12 @@
# GitHub Action for Git Push
The GitHub Actions for pushing to Git repository local changes authorizing using GitHub token.
The GitHub Actions for pushing to GitHub repository local changes authorizing using GitHub token.
## Usage
### Example Workflow file
An example workflow to authenticate with Google Cloud Platform:
An example workflow to authenticate with GitHub Platform:
```yaml
jobs:
@ -23,18 +22,6 @@ jobs:
repo-token: ${{ secrets.GITHUB_TOKEN }}
```
Subsequent actions in the workflow will then be able to use `gcloud` as that user ([see `cli` for examples](/cli)).
### Secrets
* `GCLOUD_AUTH` **Required** Base64 encoded service account key exported as JSON
- For information about service account keys please see the [Google Cloud docs](https://cloud.google.com/sdk/docs/authorizing)
- For information about using Secrets in Actions please see the [Actions docs](https://developer.github.com/actions/creating-workflows/storing-secrets/).
Example on encoding from a terminal : `base64 ~/<account_id>.json`
## License
The Dockerfile and associated scripts and documentation in this project are released under the [MIT License](LICENSE).
Container images built with this project include third party materials. See [THIRD_PARTY_NOTICE.md](THIRD_PARTY_NOTICE.md) for details.