diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 70831dc..1498cff 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -12,8 +12,8 @@ permissions: contents: read jobs: - test-javascript: - name: JavaScript Tests + lint-javascript: + name: Lint & Format runs-on: ubuntu-latest steps: diff --git a/.github/workflows/linter.yml b/.github/workflows/linter.yml index 58eb004..cc53cd8 100644 --- a/.github/workflows/linter.yml +++ b/.github/workflows/linter.yml @@ -58,3 +58,5 @@ jobs: VALIDATE_JAVASCRIPT_STANDARD: false VALIDATE_JSCPD: false VALIDATE_JSON: false + # textlint terminology rules flag "repo"/"git" as errors — wrong for engineering docs. + VALIDATE_NATURAL_LANGUAGE: false diff --git a/README.md b/README.md index 2c03b98..98e495b 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ GitHub Action that performs cross run concurrent pool locking - interoperable with [Concourse Pool](https://github.com/concourse/pool-resource) resource via git -### Usage +## Usage ```yaml - uses: sandipndev/pool-lock@0.0.1 @@ -16,11 +16,11 @@ git git_ssh_key: ${{ secrets.CUSTOM_SSH_KEY_FOR_POOL_REPO_ACCESS }} ``` -### Pool Repo Structure +## Pool Repo Structure The pool repo should have the following structure: -``` +```text ${pool}/ claimed/ .gitkeep