Skip to content
This repository has been archived by the owner on Oct 20, 2020. It is now read-only.

Commit

Permalink
Improve documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
fregante committed Sep 25, 2019
1 parent 9a73873 commit 614530a
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 12 deletions.
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,20 +9,20 @@ See [action.yml](action.yml)
Basic:

```yaml
steps:
- uses: actions/checkout@master
- uses: fregante/setup-git-token@v1
with:
token: ${{ secret.GITHUB_TOKEN }}
- run: git branch new-branch
- run: git push origin new-branch
steps:
- uses: actions/checkout@master
- uses: fregante/setup-git-token@v1
with:
token: ${{ secrets.GITHUB_TOKEN }}
- run: git branch new-branch
- run: git push origin new-branch
```
By default, new commits and tags will be assigned to the [@actions](https://github.com/actions) user. If you wish to customize the committer, specify that using `with.email` and `with.name`:

```yaml
- uses: fregante/setup-git-token@v1
with:
name: The Bot
email: bot@example.com
- uses: fregante/setup-git-token@v1
with:
name: The Bot
email: bot@example.com
```
2 changes: 1 addition & 1 deletion action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ name: Setup GIT token
description: GitHub Action that sets the GITHUB_TOKEN as credentials for git (enables `git push`)
author: Federico Brigante
branding:
icon: key
icon: chevron-up
color: yellow
inputs:
token:
Expand Down

0 comments on commit 614530a

Please sign in to comment.