From b500fbd85138518ca46153fd8d6ff0f1a21dee2d Mon Sep 17 00:00:00 2001 From: Caitlin Elfring Date: Thu, 3 Sep 2020 00:03:36 -0400 Subject: [PATCH] Fix inputs --- README.md | 20 ++++++++++---------- action.yml | 16 ++++++++-------- 2 files changed, 18 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 96e41cf..2efd8a5 100644 --- a/README.md +++ b/README.md @@ -11,22 +11,22 @@ The output of the actions can be viewed from the Actions tab in the main reposit The most common usage is to run `woke` on a file/directory. This workflow can be configured by adding the following content to the GitHub Actions workflow YAML file (ie in `.github/workflows/woke.yaml`). ```yaml -name: 'woke GitHub Actions' +name: woke on: - pull_request jobs: woke: - name: 'woke' + name: woke runs-on: ubuntu-latest steps: - - name: 'Checkout' - uses: actions/checkout@master + - name: Checkout + uses: actions/checkout@v2 - - name: 'woke' + - name: woke uses: get-woke/woke-action@v0 with: # Cause the check to fail on any broke rules - fail_on_error: true + fail-on-error: true ``` ## Inputs @@ -35,11 +35,11 @@ Inputs to configure the `woke` GitHub Actions. | Input | Default | Description | |------------------|-----------------------|---------------------------------------------------------------------------------------------------| -| `woke_args` | `.` | (Optional) Additional flags to run woke with (see ) | -| `woke_version` | latest | (Optional) Release version of `woke` (defaults to latest version) | -| `fail_on_error` | `false` | (Optional) Fail the GitHub Actions check for any failures. | +| `woke-args` | `.` | (Optional) Additional flags to run woke with (see ) | +| `woke-version` | latest | (Optional) Release version of `woke` (defaults to latest version) | +| `fail-on-error` | `false` | (Optional) Fail the GitHub Actions check for any failures. | | `workdir` | `.` | (Optional) Run `woke` this working directory relative to the root directory. | -| `github_token` | `${{ github.token }}` | (Optional) Custom GitHub Access token (ie `${{ secrets.MY_CUSTOM_TOKEN }}`). | +| `github-token` | `${{ github.token }}` | (Optional) Custom GitHub Access token (ie `${{ secrets.MY_CUSTOM_TOKEN }}`). | ## License diff --git a/action.yml b/action.yml index 3cca1bd..2ffd6d0 100644 --- a/action.yml +++ b/action.yml @@ -2,15 +2,15 @@ name: 'Run woke' description: 'Run woke on pull requests to detect non-inclusive language in your source code.' author: 'Caitlin Elfring (caitlinelfring)' inputs: - github_token: + github-token: description: 'GITHUB_TOKEN' required: true default: ${{ github.token }} - woke_args: + woke-args: description: 'woke arguments' default: '.' required: false - fail_on_error: + fail-on-error: description: | Exit code when errors are found [true,false] Default is `false`. @@ -20,7 +20,7 @@ inputs: description: 'Working directory relative to the root directory.' default: '.' required: false - woke_version: + woke-version: description: 'woke version' default: '' # uses latest, should be pinned? # 'v0.1' required: false @@ -32,10 +32,10 @@ runs: env: # INPUT_ is not available in Composite run steps # https://github.com/actions/runner/issues/665 - INPUT_GITHUB_TOKEN: ${{ inputs.github_token }} - INPUT_WOKE_VERSION: ${{ inputs.version }} - INPUT_WOKE_FLAGS: ${{ inputs.woke_args }} - INPUT_FAIL_ON_ERROR: ${{ inputs.fail_on_error }} + INPUT_GITHUB_TOKEN: ${{ inputs.github-token }} + INPUT_WOKE_VERSION: ${{ inputs.woke-version }} + INPUT_WOKE_ARGS: ${{ inputs.woke-args }} + INPUT_FAIL_ON_ERROR: ${{ inputs.fail-on-error }} INPUT_WORKDIR: ${{ inputs.workdir }} branding: icon: 'check-circle'