Skip to content

feat(ci): add ci/cd#12

Merged
avivkeller merged 2 commits intomainfrom
cicd
Mar 12, 2026
Merged

feat(ci): add ci/cd#12
avivkeller merged 2 commits intomainfrom
cicd

Conversation

@avivkeller
Copy link
Member

Fixes #9

Copilot AI review requested due to automatic review settings March 12, 2026 21:14
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds an initial CI/CD setup and supporting tooling for generating versioned TypeDoc Markdown, converting it to HTML via doc-kit, and deploying the result to GitHub Pages (with a scheduled sync against upstream webpack).

Changes:

  • Introduces GitHub Actions workflows for linting, docs freshness checks, Pages deploy, and daily upstream sync.
  • Updates the TypeDoc generation pipeline to output into versioned pages/v{major}.x and emits a type-map.json into that output directory.
  • Adds repo tooling for formatting/linting (ESLint + Prettier) and commit-time checks (Husky + lint-staged), plus generated docs/content under pages/.

Reviewed changes

Copilot reviewed 52 out of 57 changed files in this pull request and generated 4 comments.

Show a summary per file
File Description
tsconfig.json Tweaks TS compiler options for repo tooling (no emit, skip lib check).
plugins/theme/partials/types.mjs Fixes module syntax/formatting for theme partials.
plugins/theme/partials/index.mjs Normalizes quoting/formatting and string handling in partials.
plugins/theme/index.mjs Normalizes quoting/formatting; keeps theme registration consistent.
plugins/theme/helpers/index.mjs Normalizes quoting/formatting in helper rendering utilities.
plugins/processor.mjs Writes type-map.json into the configured TypeDoc out directory.
pages/v5.x/webpack/namespaces/webworker.md Generated docs content for webworker namespace.
pages/v5.x/webpack/namespaces/web.md Generated docs content for web namespace.
pages/v5.x/webpack/namespaces/wasm.md Generated docs content for wasm namespace.
pages/v5.x/webpack/namespaces/util/namespaces/serialization.md Generated docs content for util.serialization.
pages/v5.x/webpack/namespaces/util/namespaces/runtime.md Generated docs content for util.runtime.
pages/v5.x/webpack/namespaces/util/namespaces/compileBooleanMatcher.md Generated docs content for util.compileBooleanMatcher.
pages/v5.x/webpack/namespaces/util/namespaces/comparators.md Generated docs content for util.comparators.
pages/v5.x/webpack/namespaces/util/index.md Generated docs content for util namespace index.
pages/v5.x/webpack/namespaces/sources.md Generated docs content for sources namespace.
pages/v5.x/webpack/namespaces/sharing.md Generated docs content for sharing namespace.
pages/v5.x/webpack/namespaces/runtime.md Generated docs content for runtime namespace.
pages/v5.x/webpack/namespaces/prefetch.md Generated docs content for prefetch namespace.
pages/v5.x/webpack/namespaces/optimize/namespaces/InnerGraph.md Generated docs content for optimize.InnerGraph.
pages/v5.x/webpack/namespaces/optimize/index.md Generated docs content for optimize namespace index.
pages/v5.x/webpack/namespaces/node.md Generated docs content for node namespace.
pages/v5.x/webpack/namespaces/library.md Generated docs content for library namespace.
pages/v5.x/webpack/namespaces/javascript.md Generated docs content for javascript namespace.
pages/v5.x/webpack/namespaces/ids.md Generated docs content for ids namespace.
pages/v5.x/webpack/namespaces/experiments/namespaces/schemes.md Generated docs content for experiments.schemes.
pages/v5.x/webpack/namespaces/experiments/namespaces/ids.md Generated docs content for experiments.ids.
pages/v5.x/webpack/namespaces/experiments/index.md Generated docs content for experiments namespace index.
pages/v5.x/webpack/namespaces/esm.md Generated docs content for esm namespace.
pages/v5.x/webpack/namespaces/electron.md Generated docs content for electron namespace.
pages/v5.x/webpack/namespaces/dependencies.md Generated docs content for dependencies namespace.
pages/v5.x/webpack/namespaces/debug.md Generated docs content for debug namespace.
pages/v5.x/webpack/namespaces/css.md Generated docs content for css namespace.
pages/v5.x/webpack/namespaces/container.md Generated docs content for container namespace.
pages/v5.x/webpack/namespaces/config.md Generated docs content for config namespace.
pages/v5.x/webpack/namespaces/cli.md Generated docs content for cli namespace.
pages/v5.x/webpack/namespaces/cache.md Generated docs content for cache namespace.
pages/v5.x/webpack/namespaces/RuntimeGlobals.md Generated docs content for RuntimeGlobals namespace.
pages/v5.x/webpack/namespaces/OptimizationStages.md Generated docs content for OptimizationStages namespace.
pages/v5.x/webpack/namespaces/ModuleFilenameHelpers.md Generated docs content for ModuleFilenameHelpers namespace.
pages/v5.x/_media/WORKING_GROUP.md Adds working-group media content (generated/imported).
pages/v5.x/_media/GOVERNANCE.md Adds governance media content (generated/imported).
package.json Adds scripts and tooling deps for generation/lint/format/hooks.
generate-md.mjs Generates docs into versioned pages/v{major}.x output directory.
eslint.config.mjs Adds ESLint flat config and repo ignores.
README.md Documents project purpose, structure, and scripts.
HEAD_COMMIT Pins the upstream webpack commit used for generation.
.prettierignore Ignores generated/output directories and vendor content.
.lintstagedrc Configures lint-staged for pre-commit formatting/linting.
.husky/pre-commit Adds pre-commit hook invoking lint-staged.
.gitignore Adjusts ignored patterns for generated/vendor directories.
.github/workflows/sync.yml Adds scheduled workflow to sync upstream webpack and regen docs.
.github/workflows/deploy.yml Updates Pages deploy workflow to use pinned HEAD_COMMIT for webpack.
.github/workflows/ci.yml Adds CI lint/format job and PR docs freshness check.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@avivkeller avivkeller merged commit e5b8286 into main Mar 12, 2026
3 checks passed
@avivkeller avivkeller deleted the cicd branch March 12, 2026 21:35
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.

Basic CI/CD generating docs

3 participants