w9r.dev/action-git-commit-push
w9r.dev/action-git-commit-push
4
0
Fork 0
Code Issues 1 Pull requests Projects Releases Packages Wiki Activity Actions

update inouts descriptions

Browse source 
Signed-off-by: GuillaumeFalourd <guillaume.falourd@zup.com.br>
This commit is contained in:
GuillaumeFalourd 2021-10-21 15:31:33 -03:00
parent c502e22daa
commit ad666fad87
2 changed files with 12 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -59,10 +59,10 @@ Field | Mandatory | Default Value | Observation
------------ | ------------ | ------------- | ------------- ------------ | ------------ | ------------- | -------------
**email** | NO | `${{ github.actor }}@users.noreply.github.com` | Github user email <br/> _e.g: `octocat@github.com`_ **email** | NO | `${{ github.actor }}@users.noreply.github.com` | Github user email <br/> _e.g: `octocat@github.com`_
**name** | NO | `${{ github.actor }}` | Github username <br/> _e.g: `octocat`_ **name** | NO | `${{ github.actor }}` | Github username <br/> _e.g: `octocat`_
**commit_message** | NO | | The commit message **commit_message** | NO | | Commit message
**target_branch** | NO | `${{ github.ref }}` | The branch to push the changes back to **target_branch** | NO | `${{ github.ref }}` | Branch to push the changes back
**files** | NO | `.` (all) | The files to add separated by space <br/> _e.g: `file1 file2 directory1 directory2/file3`_ **files** | NO | `.` (all) | Files to add separated by space <br/> _e.g: `file1 file2 directory1 directory2/file3`_
**remote_repository** | NO | `origin` | The repository to push the code to **remote_repository** | NO | `origin` | Repository to push the code
**access_token** | NO | `${{ github.token }}` | [Personal Access Token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) (necessary if push to another repository). **access_token** | NO | `${{ github.token }}` | [Personal Access Token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) (necessary if push to another repository).
**force** | NO | | Whether to perform force push **force** | NO | | Whether to perform force push
**empty** | NO | | Whether to allow empty commit **empty** | NO | | Whether to allow empty commit

16
action.yml
View file

@ -4,31 +4,31 @@ description: 'GitHub Action to commit & push changes made in workflows to upstre
inputs: inputs:
email: email:
description: The committer's email address description: Committer's email address
required: true required: true
default: ${{ github.actor }}@users.noreply.github.com default: ${{ github.actor }}@users.noreply.github.com
name: name:
description: The committer's name description: Committer's username
required: true required: true
default: ${{ github.actor }} default: ${{ github.actor }}
commit_message: commit_message:
description: The commit message description: Commit message
required: true required: true
default: Automatically updated using GitHub Actions default: Automatically updated using Push and Commit action
target_branch: target_branch:
description: The branch to push the changes back to description: Branch to push the changes back to
required: true required: true
default: ${{ github.ref }} default: ${{ github.ref }}
files: files:
description: The files to add separated by space description: Files to add separated by space
required: true required: true
default: . default: .
remote_repository: remote_repository:
description: The repository to push the code to description: Repository to push the code to
required: true required: true
default: origin default: origin
access_token: access_token:
description: The token used to push the code description: Token used to push the code
required: true required: true
default: ${{ github.token }} default: ${{ github.token }}
force: force: