feat: api docs generator#591
Open
akudev wants to merge 1 commit into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds an API documentation generation toolchain to the repo and a scheduled/manual GitHub Actions workflow to publish the generated HTML docs to gh-pages.
Changes:
- Introduce a standalone
scripts/generate-api-docsNode-based generator (TypeDoc → Markdown → minimal HTML + sitemap/index). - Add a scheduled + workflow_dispatch GitHub Actions workflow to generate OpenUI5/SAPUI5 docs and push results to
gh-pages. - Add an (empty) changeset documenting the infrastructure-only addition.
Reviewed changes
Copilot reviewed 5 out of 6 changed files in this pull request and generated 7 comments.
Show a summary per file
| File | Description |
|---|---|
scripts/generate-api-docs/package.json |
Defines the generator’s Node package scripts and pinned dependencies. |
scripts/generate-api-docs/package-lock.json |
Locks generator dependency graph for deterministic installs. |
scripts/generate-api-docs/generate.mjs |
Implements the full docs generation pipeline and HTML rendering. |
scripts/generate-api-docs/.npmrc |
Sets npm/pnpm install-related config for the generator subproject. |
.github/workflows/generate-api-docs.yml |
Automates monthly/manual docs generation and publishes to gh-pages. |
.changeset/add-api-docs-generator.md |
Documents the infra-only change via an empty changeset. |
Files not reviewed (1)
- scripts/generate-api-docs/package-lock.json: Generated file
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
akudev
force-pushed
the
feat/api-docs-generator
branch
2 times, most recently
from
407771c to
f64a6e4
Compare
akudev
force-pushed
the
feat/api-docs-generator
branch
from
f64a6e4 to
73f7f24
Compare
akudev
force-pushed
the
feat/api-docs-generator
branch
from
73f7f24 to
898bed3
Compare
akudev
force-pushed
the
feat/api-docs-generator
branch
from
898bed3 to
8d64b48
Compare
akudev
force-pushed
the
feat/api-docs-generator
branch
from
8d64b48 to
d11f099
Compare
Adds a script that generates crawlable HTML API reference pages from @openui5/types and @sapui5/types npm packages using TypeDoc. Pipeline: 1. Install types package (pinned, --ignore-scripts, allowlisted) 2. Preprocess .d.ts (rename default exports to named, collect export map) 3. Run TypeDoc with markdown plugin 4. Strip inherited members (reduces ~300MB to ~47MB) 5. Render minimal static HTML with import hints, breadcrumbs, sitemap GitHub Actions workflow: - Nightly cron (cheap version check via .version marker files) - Fetches LTS + latest versions from versionoverview.json (hard floor: 1.120) - Generates only versions with new patches, skips up-to-date ones - Resilient: one failure does not block other versions - Manual workflow_dispatch for on-demand generation Security: - .npmrc: registry pin, ignore-scripts, allow-git=none, min-release-age - All deps pinned to exact versions with committed lockfile - Actions pinned to SHA digests with version comments - Workflow permissions scoped (contents:read default, write at job level) - Node version pinned to exact patch - No npx in generator (local bin path only) - Types packages allowlisted
akudev
force-pushed
the
feat/api-docs-generator
branch
from
d11f099 to
9ccc289
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.