From 5432544bdb73ae9eeeeb763f934bbb33bca3a0d6 Mon Sep 17 00:00:00 2001 From: Stefan Zweifel Date: Wed, 5 Feb 2020 20:24:25 +0100 Subject: [PATCH] Update Docs --- README.md | 4 ++-- action.yml | 12 ++++++------ 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index c190d45..b4368f8 100644 --- a/README.md +++ b/README.md @@ -28,10 +28,10 @@ Add the following step at the end of your job. # Optional glob pattern of files which should be added to the commit file_pattern: src/\*.js - # Optional repository path + # Optional local file path to the repository repository: . - # Optional commit user settings + # Optional commit user and author settings commit_user_name: My GitHub Actions Bot commit_user_email: my-github-actions-bot@example.org commit_author: Author diff --git a/action.yml b/action.yml index 7fd5e8d..c5c0b53 100644 --- a/action.yml +++ b/action.yml @@ -7,18 +7,18 @@ inputs: commit_message: description: Commit message required: true + branch: + description: Git branch name, where changes should be pushed too. + required: true commit_options: description: Commit options (eg. --no-verify) required: false - branch: - description: Branch name where changes should be pushed too - required: true file_pattern: - description: File pattern used for "git add" + description: File pattern used for `git add`. For example `src/\*.js` required: false default: '.' repository: - description: Path to git repository + description: Local file path to the git repository. Defaults to the current directory (`.`) required: false default: '.' commit_user_name: @@ -30,7 +30,7 @@ inputs: required: false default: actions@github.com commit_author: - description: Value used for the commit author + description: Value used for the commit author. Defaults to the username of whoever triggered this workflow run. required: false default: ${{ github.actor }} <${{ github.actor }}@users.noreply.github.com>