Skip to content

[#3349] Installed Vale in CI from the public release instead of the unauthenticated '@vvago/vale' API download. - #3354

Open
AlexSkrypnyk wants to merge 1 commit into
mainfrom
feature/3349-vale-ci-install
Open

AlexSkrypnyk wants to merge 1 commit into
mainfrom
feature/3349-vale-ci-install

Conversation

@AlexSkrypnyk

@AlexSkrypnyk AlexSkrypnyk commented Nov 19, 2026 •

Copy link
Copy Markdown
Member

Closes #3349

Summary

CI no longer runs the @vvago/vale postinstall. Every yarn install of the docs dependencies in a workflow now passes --ignore-scripts, and vortex-test-docs.yml installs the Vale binary itself from github.com/vale-cli/vale/releases/download/..., checked against a pinned VALE_SHA256.

The wrapper's postinstall downloads the binary from api.github.com/repos/vale-cli/vale/releases/assets/<id> without a token. That counts against GitHub's unauthenticated limit of 60 requests per hour per IP, and hosted runners share IPs, so when the limit was spent the install failed with Download failed with status code: 403. That hit roughly 1 in 4 runs of vortex-test-installer (8.3) and could hit the docs test and release jobs the same way.

After merge, the docs, installer and release workflows make no unauthenticated GitHub API calls for Vale, and the Jest vale-rules.test.js, yarn lint-prose and vale sync run unchanged against the installed binary. If @vvago/vale moves to a version that doesn't match VALE_VERSION, the docs job fails with a message to update both values. Local development is untouched: yarn install on a workstation still gets its binary from the wrapper.

Before / After

BEFORE (every docs 'yarn install' in CI)

  yarn install
      │
      ▼
  @vvago/vale postinstall
      │  GET api.github.com/.../releases/assets/<id>   (no token)
      ▼
  shared runner IP over 60/hour? ──yes──► 403 ──► job fails
      │ no
      ▼
  native/vale


AFTER

  vortex-test-docs.yml                     installer video, release, combined build
  ────────────────────                     ────────────────────────────────────────
  yarn install --ignore-scripts            yarn install --ignore-scripts
      │                                        │
      ▼                                        ▼
  VALE_VERSION == locked @vvago/vale?       (Vale not needed)
      │ yes            no ──► fail with
      ▼                       update message
  curl github.com/.../releases/download/...  (public URL, no API quota)
      │
      ▼
  sha256sum --check VALE_SHA256
      │
      ▼
  extract to node_modules/@vvago/vale/native/vale
      │
      ▼
  yarn run postinstall  (vale sync)
      │
      ▼
  lint, Jest vale-rules test, lint-prose

Changes

Docs workflow (.github/workflows/vortex-test-docs.yml)

  • yarn install --frozen-lockfile --ignore-scripts.
  • New "Install Vale" step: checks that VALE_VERSION matches the locked @vvago/vale, downloads the Linux tarball from the public release URL, verifies VALE_SHA256, extracts vale into the directory the wrapper's .bin/vale launcher runs it from, then runs yarn run postinstall for vale sync.

Workflows that don't run Vale

  • .github/workflows/vortex-test-installer.yml: the installer video step installs with --ignore-scripts (the same 1-line change as Skipped install scripts in the installer video step so the Vale binary download no longer fails the job. #3348).
  • .github/workflows/vortex-release.yml: the docs job installs with --ignore-scripts, and the video step drops its second yarn install, because the same job has already installed the dependencies.
  • .vortex/docs/.utils/assemble-combined-docs.sh: the combined-site install uses --ignore-scripts. It only builds the site.

Maintenance notes (.vortex/docs/CLAUDE.md)

  • Documents the CI install and that VALE_VERSION and VALE_SHA256 change together with @vvago/vale.

The other install scripts skipped by --ignore-scripts aren't needed. core-js only prints a banner. unrs-resolver fetches a native binding only when its optional dependency is missing, and Yarn installs optional dependencies anyway. @parcel/watcher builds only when npm_config_build_from_source=true.

I replayed the new docs steps in a clean node:22 Linux container. yarn run lint, vale-rules.test.js (35/35) and yarn lint-prose (0 errors in 85 files) all passed, and the version check tripped on a mismatched version.

Summary by CodeRabbit

  • Chores
    • Documentation and installer-video workflows now install dependencies from the lockfile without running lifecycle scripts.
    • Documentation checks verify the Vale version and downloaded binary checksum before using Vale.
    • Documentation guidance now explains the Vale version and checksum settings that must be updated together.

@coderabbitai

coderabbitai Bot commented Nov 19, 2026 •

Copy link
Copy Markdown

Explain Change →

No actionable comments were generated in the recent review.

Walkthrough

The workflows and combined-docs script now skip dependency lifecycle scripts during Yarn installs. The docs workflow installs Vale separately, checks its version against the lockfile, verifies the release archive checksum, extracts the binary, and runs the package postinstall script. Documentation records the CI setup and version-update values.

Changes: Vale CI installation

Layer / File(s) Summary
Disable dependency lifecycle scripts
.github/workflows/vortex-test-docs.yml, .github/workflows/vortex-release.yml, .github/workflows/vortex-test-installer.yml, .vortex/docs/.utils/assemble-combined-docs.sh
The affected Yarn install commands now use --ignore-scripts. The installer-video generation step in the release workflow no longer runs a separate Yarn install.
Install pinned Vale binary
.github/workflows/vortex-test-docs.yml, .vortex/docs/CLAUDE.md
The docs workflow checks the Vale version against the package lock, verifies the downloaded archive checksum, extracts the binary, and runs the package postinstall script. The Prose linting guidance describes this CI setup and the Vale version and checksum values to update.

Estimated code review effort: 3 (Moderate) | ~20 minutes

Severity of issue fixed: Medium

Merge Risk: Minimal · up to 809b1

CI installs now skip dependency lifecycle scripts, and the docs workflow installs a version-checked, checksum-verified Vale binary. No merge-blocking risk was found. Local development is unchanged.

Pre-merge checks: Passed 4

Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title names the main change: Vale is now installed in CI from the public release rather than through the unauthenticated @vvago/vale postinstall download. The raw summary and objectives both descr…
Linked Issues check Passed [#3349] Requirements covered at the reviewed head:
- Vale install from public URL with pinned SHA-256: vortex-test-docs.yml adds an "Install Vale" step that curls `github.com/vale-cli/vale/releases/…
Out of Scope Changes check Passed All changed files relate to #3349 or its supporting work:
- .github/workflows/vortex-test-docs.yml: --ignore-scripts install and the Vale install step (core requirement).
- `.github/workflows/vort…
Full details: Title check

Explanation

The title names the main change: Vale is now installed in CI from the public release rather than through the unauthenticated @vvago/vale postinstall download. The raw summary and objectives both describe this change, and the linked issue #3349 matches it. The title is specific and accurate, though long (111 characters), which is a minor readability issue rather than a relevance problem.

Full details: Linked Issues check

Explanation

[#3349] Requirements covered at the reviewed head:

  • Vale install from public URL with pinned SHA-256: vortex-test-docs.yml adds an "Install Vale" step that curls github.com/vale-cli/vale/releases/download/v${VALE_VERSION}/...tar.gz and runs sha256sum --check --strict against VALE_SHA256. This follows the asciinema pattern in vortex-release.yml.
  • No CI docs install triggers the wrapper download: yarn install --frozen-lockfile --ignore-scripts is set in vortex-test-docs.yml and vortex-release.yml. The PR also adds --ignore-scripts to the installer video step and assemble-combined-docs.sh, per the PR description. The summary for these files was not re-read in full.
  • yarn lint-prose and vale sync: the step extracts the binary to node_modules/@vvago/vale/native/vale and runs yarn run postinstall. The PR reports replay results in a node:22 container.
  • Vale version alignment: the step fails when VALE_VERSION differs from the locked @vvago/vale version. The PR states that the version is pinned in the workflow env.
  • Coverage of vortex-release.yml and the combined-docs script: both install with --ignore-scripts. The redundant yarn install in the video step is removed.
  • Local yarn install is unchanged, as the issue requires.
    The Jest and lint runs were reported by the author and not re-executed in this review.
Full details: Out of Scope Changes check

Explanation

All changed files relate to #3349 or its supporting work:

  • .github/workflows/vortex-test-docs.yml: --ignore-scripts install and the Vale install step (core requirement).
  • .github/workflows/vortex-release.yml: --ignore-scripts install for the docs job. The removal of the second yarn install is justified by the earlier install in the same job, per the PR description.
  • .github/workflows/vortex-test-installer.yml: --ignore-scripts on the video step. This is a 1-line change that the issue states is already in scope under #3348.
  • .vortex/docs/.utils/assemble-combined-docs.sh: --ignore-scripts, named in #3349.
  • .vortex/docs/CLAUDE.md: maintenance notes on the version pin, supporting the version-alignment requirement.
    No unrelated change was found.
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Recent review info

Run configuration

Commits

Reviewing files that changed from the base of the PR and between cb05bef and 809b178.

Files selected for processing: 5

  • .github/workflows/vortex-release.yml
  • .github/workflows/vortex-test-docs.yml
  • .github/workflows/vortex-test-installer.yml
  • .vortex/docs/.utils/assemble-combined-docs.sh
  • .vortex/docs/CLAUDE.md

Included review availability: This review used your included allowance. 2 included reviews remain after this review. Your included PR review attempts over the past 7 days set your current allowance at 4 reviews per hour.

@github-actions

Copy link
Copy Markdown

📖 Documentation preview for this pull request has been deployed to Netlify:

https://6afe4fab692cd48cc5cd18b0--vortex-docs.netlify.app

This preview is rebuilt on every commit and is not the production documentation site.

@github-actions

This comment has been minimized.

@AlexSkrypnyk

This comment has been minimized.

@github-actions

This comment has been minimized.

@AlexSkrypnyk

This comment has been minimized.

1 similar comment
@AlexSkrypnyk

Copy link
Copy Markdown
Member Author

Code coverage (threshold: 90%)

  Classes: 100.00% (1/1)
  Methods: 100.00% (2/2)
  Lines:   99.15% (233/235)
Per-class coverage
Drupal\ys_demo\Plugin\Block\CounterBlock
  Methods: 100.00% ( 2/ 2)   Lines: 100.00% ( 10/ 10)

@github-actions

Copy link
Copy Markdown

Code coverage (threshold: 90%)

  Classes: 100.00% (1/1)
  Methods: 100.00% (2/2)
  Lines:   99.15% (233/235)
Per-class coverage
Drupal\ys_demo\Plugin\Block\CounterBlock
  Methods: 100.00% ( 2/ 2)   Lines: 100.00% ( 10/ 10)

@codecov

codecov Bot commented Nov 19, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 92.67%. Comparing base (cb05bef) to head (809b178).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #3354   +/-   ##
=======================================
  Coverage   92.67%   92.67%           
=======================================
  Files         117      117           
  Lines        5163     5163           
  Branches       49       49           
=======================================
  Hits         4785     4785           
  Misses        378      378           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@AlexSkrypnyk AlexSkrypnyk added the Needs review Pull request needs a review from assigned developers label Nov 19, 2026

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A4 Board worker 4 Needs review Pull request needs a review from assigned developers

Projects

Status: BACKLOG

Development

Successfully merging this pull request may close these issues.

Install Vale in CI without the unauthenticated npm wrapper download

1 participant