Skip to content

feat(docs): automate versioned example imports#62

Merged
demtario merged 1 commit into
feature/DEV-2099_Versioned-docs-examplesfrom
feature/DEV-2101_docs-example-ci
Jul 17, 2026
Merged

feat(docs): automate versioned example imports#62
demtario merged 1 commit into
feature/DEV-2099_Versioned-docs-examplesfrom
feature/DEV-2101_docs-example-ci

Conversation

@demtario

@demtario demtario commented Jul 17, 2026

Copy link
Copy Markdown
Contributor

Summary

Task: https://app.clickup.com/t/9015210959/DEV-2101

  • add a matrix workflow that imports release and next docs buckets, summarizes each branch, and creates a generated-content PR
  • resolve imported npm and Angular type dependencies to immutable registry versions
  • document CI-owned docs-example generation

Test plan

PR intentionally merged into another feature branch, to not break production logic with partial changes.


Note

Medium Risk
Introduces CI that checks out an external repo, calls npm during imports, and opens PRs with contents:write, but changes are confined to docs-example generation and dependency pinning rather than runtime auth or production app logic.

Overview
Docs example snapshots are now produced in GitHub Actions instead of relying on developers to run the importer locally. A new Import versioned docs examples workflow builds a branch matrix (release bucket from npm handsontable dist-tags.latestprod-docs/<major.minor>, plus developnext, or a single branch via repository_dispatch / docs-examples-sync), sparse-checks out handsontable/handsontable docs content per job, runs import-docs.mjs, uploads bucket artifacts, and on success opens or updates an automated PR (chore/docs-example-buckets) with merged output under apps/authoring/public/docs-examples/. Job summaries report import outcome, HOT version, and per-framework counts.

The importer pins every discovered extra npm dependency (and Angular @types/* for papaparse/moment) to concrete registry dist-tags.latest versions via shared resolveNpmPackageVersion; failures are fatal and generated package.json files no longer contain "latest". runner/docs/docs-examples.md documents CI ownership, tokens, and local-only debugging.

Reviewed by Cursor Bugbot for commit 1daa4ae. Bugbot is set up for automated code reviews on this repo. Configure here.

Generate release and next buckets in CI while pinning imported dependencies to concrete npm versions for reproducible snapshots.
@demtario demtario self-assigned this Jul 17, 2026
@demtario
demtario force-pushed the feature/DEV-2101_docs-example-ci branch from 1daa4ae to 48504ec Compare July 17, 2026 10:45
@demtario
demtario requested a review from budnix July 17, 2026 10:45
@demtario
demtario merged commit 266157b into feature/DEV-2099_Versioned-docs-examples Jul 17, 2026
4 checks passed
@demtario
demtario deleted the feature/DEV-2101_docs-example-ci branch July 17, 2026 10:47
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.

2 participants