Repository navigation
[#3349] Installed Vale in CI from the public release instead of the unauthenticated '@vvago/vale' API download. - #3354
AlexSkrypnyk wants to merge 1 commit into
Conversation
…nauthenticated '@vvago/vale' API download.
|
No actionable comments were generated in the recent review. Walkthrough
Merge Risk:
|
|
📖 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. |
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
1 similar comment
|
Code coverage (threshold: 90%) Per-class coverage |
|
Code coverage (threshold: 90%) Per-class coverage |
Codecov Report✅ All modified and coverable lines are covered by tests. 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. 🚀 New features to boost your workflow:
|
Closes #3349
Summary
CI no longer runs the
@vvago/valepostinstall. Everyyarn installof the docs dependencies in a workflow now passes--ignore-scripts, andvortex-test-docs.ymlinstalls the Vale binary itself fromgithub.com/vale-cli/vale/releases/download/..., checked against a pinnedVALE_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 withDownload failed with status code: 403. That hit roughly 1 in 4 runs ofvortex-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-proseandvale syncrun unchanged against the installed binary. If@vvago/valemoves to a version that doesn't matchVALE_VERSION, the docs job fails with a message to update both values. Local development is untouched:yarn installon a workstation still gets its binary from the wrapper.Before / After
Changes
Docs workflow (
.github/workflows/vortex-test-docs.yml)yarn install --frozen-lockfile --ignore-scripts.VALE_VERSIONmatches the locked@vvago/vale, downloads the Linux tarball from the public release URL, verifiesVALE_SHA256, extractsvaleinto the directory the wrapper's.bin/valelauncher runs it from, then runsyarn run postinstallforvale 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 secondyarn 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)VALE_VERSIONandVALE_SHA256change together with@vvago/vale.The other install scripts skipped by
--ignore-scriptsaren't needed.core-jsonly prints a banner.unrs-resolverfetches a native binding only when its optional dependency is missing, and Yarn installs optional dependencies anyway.@parcel/watcherbuilds only whennpm_config_build_from_source=true.I replayed the new docs steps in a clean
node:22Linux container.yarn run lint,vale-rules.test.js(35/35) andyarn lint-prose(0 errors in 85 files) all passed, and the version check tripped on a mismatched version.Summary by CodeRabbit