From 55641ba16b247451e15e843c13548a3c679d6528 Mon Sep 17 00:00:00 2001 From: Sandipan Dey Date: Sat, 25 Apr 2026 14:12:44 +0530 Subject: [PATCH] ci: fix misnamed lint job and quiet noisy super-linter rules MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - ci.yml job was named "JavaScript Tests" but the project has no tests and the job only runs format:check + lint — renamed to "Lint & Format" so the check status reflects what it actually does. - linter.yml: disable VALIDATE_NATURAL_LANGUAGE; textlint's terminology rules flag "repo" → "repository" and "git" → "Git" as errors, which is wrong for engineering docs and was the recurring lint failure. - README.md: fix real markdownlint findings — promote the h3 headings to h2 (MD001) and tag the structure code fence as `text` (MD040). Co-Authored-By: Claude Opus 4.7 (1M context) --- .github/workflows/ci.yml | 4 ++-- .github/workflows/linter.yml | 2 ++ README.md | 6 +++--- 3 files changed, 7 insertions(+), 5 deletions(-) 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