Skip to content

ci: pin docs validation to exact published SDK version - #168

Merged
truthixify merged 3 commits into
wraith-protocol:developfrom
boalambo:ci/pin-sdk-version-validation
Sep 28, 2026
Merged

truthixify merged 3 commits into
wraith-protocol:developfrom
boalambo:ci/pin-sdk-version-validation

Conversation

@boalambo

@boalambo boalambo commented Sep 25, 2026 •

Copy link
Copy Markdown
Contributor

Closes #153


  • Add extract-sdk-version job to dynamically read SDK version from package.json
  • Download published SDK artifact as .tgz before installing
  • Install packed artifact instead of registry version to ensure exact match
  • Record tested SDK version in CI output for all validation jobs
  • Add sdk-version-check workflow to verify version exists on npm before allowing package.json changes
  • Pin SDK version to exact version (1.4.5) instead of caret range
  • Add documentation for SDK version update process

This ensures docs snippets and tests always validate against the exact published SDK version, preventing issues where local or floating versions differ from published releases.

@drips-wave

drips-wave Bot commented Sep 25, 2026

Copy link
Copy Markdown

@boalambo Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits.

You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀

Learn more about application limits

@boalambo

boalambo commented Sep 25, 2026 •

Copy link
Copy Markdown
Contributor Author

Please let me know if I need to make any adjustments? Thank you @truthixify

@truthixify

Copy link
Copy Markdown
Contributor

CI fails before validation because pnpm pack is being used to download a registry package. It tries to pack the docs project and reports that no package version is defined. Please fetch the exact SDK tarball with npm pack or npm view, then install that file.

1 similar comment
@truthixify

Copy link
Copy Markdown
Contributor

CI fails before validation because pnpm pack is being used to download a registry package. It tries to pack the docs project and reports that no package version is defined. Please fetch the exact SDK tarball with npm pack or npm view, then install that file.

@boalambo

Copy link
Copy Markdown
Contributor Author

CI fails before validation because pnpm pack is being used to download a registry package. It tries to pack the docs project and reports that no package version is defined. Please fetch the exact SDK tarball with npm pack or npm view, then install that file.

I will do that now

@boalambo

Copy link
Copy Markdown
Contributor Author

CI fails before validation because pnpm pack is being used to download a registry package. It tries to pack the docs project and reports that no package version is defined. Please fetch the exact SDK tarball with npm pack or npm view, then install that file.

You can check for approval now, thank you

@truthixify

Copy link
Copy Markdown
Contributor

The npm pack step works now, but all three jobs stop because package.json pins 1.4.5 while pnpm-lock.yaml still records ^1.4.5. Please regenerate and commit the lockfile, then rerun CI.

@boalambo

Copy link
Copy Markdown
Contributor Author

The npm pack step works now, but all three jobs stop because package.json pins 1.4.5 while pnpm-lock.yaml still records ^1.4.5. Please regenerate and commit the lockfile, then rerun CI.

All good, I will fix that soon

- Add extract-sdk-version job to dynamically read SDK version from package.json
- Download published SDK artifact as .tgz before installing
- Install packed artifact instead of registry version to ensure exact match
- Record tested SDK version in CI output for all validation jobs
- Add sdk-version-check workflow to verify version exists on npm before allowing package.json changes
- Pin SDK version to exact version (1.4.5) instead of caret range
- Add documentation for SDK version update process

This ensures docs snippets and tests always validate against the exact published SDK version, preventing issues where local or floating versions differ from published releases.
- Replace pnpm pack with npm pack to download from npm registry
- pnpm pack was trying to pack the local docs project instead
- npm pack correctly fetches the published package tarball
- Update tarball filename to match npm pack output format
- Regenerate pnpm-lock.yaml to reflect exact version 1.4.5 instead of ^1.4.5
- This resolves CI failure where lockfile didn't match package.json
@boalambo
boalambo force-pushed the ci/pin-sdk-version-validation branch from b18a1c7 to e6977fc Compare September 28, 2026 13:00
@boalambo

Copy link
Copy Markdown
Contributor Author

please check now @truthixify

@truthixify
truthixify merged commit b846e1e into wraith-protocol:develop Sep 28, 2026
5 checks passed
@truthixify

Copy link
Copy Markdown
Contributor

Merged. CI now tests the exact published SDK artifact and the manifest and lockfile agree. Thanks @boalambo.

@boalambo

Copy link
Copy Markdown
Contributor Author

Merged. CI now tests the exact published SDK artifact and the manifest and lockfile agree. Thanks @boalambo.
Thank you for the correction and work through.

@boalambo
boalambo deleted the ci/pin-sdk-version-validation branch September 28, 2026 14:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Wave 9] Build docs against the exact published SDK version

2 participants