feat(typedoc): Add release workflow for the TypeDoc plugin.#161
Open
feat(typedoc): Add release workflow for the TypeDoc plugin.#161
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR prepares the typedoc-plugin-react-components package for external distribution and adds a manual GitHub Actions workflow intended to build and publish the plugin to npm, aligning the build output structure with the expected dist/main.js entrypoint.
Changes:
- Adjust TypeScript build output pathing (
rootDir) so the compiled entrypoint lands atdist/main.js. - Add package metadata/docs/licensing to support publishing the plugin as a standalone npm package.
- Introduce a
workflow_dispatchGitHub Actions workflow to build, version, and publish the plugin.
Reviewed changes
Copilot reviewed 5 out of 6 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| plugins/typedoc-plugin-react-components/tsconfig.json | Updates rootDir to emit the entrypoint directly under dist/. |
| plugins/typedoc-plugin-react-components/README.md | Adds basic usage documentation for the published plugin. |
| plugins/typedoc-plugin-react-components/package.json | Updates package metadata/exports/scripts to support publishing. |
| plugins/typedoc-plugin-react-components/package-lock.json | Adds a lockfile for the plugin package’s dev toolchain. |
| plugins/typedoc-plugin-react-components/LICENSE | Adds a license file for the plugin package. |
| .github/workflows/typedoc-plugin-release.yml | Adds a manual workflow intended to version and publish the plugin to npm. |
Files not reviewed (1)
- plugins/typedoc-plugin-react-components/package-lock.json: Language not supported
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Release the plugin as a package, so it can be used for previous version of Ignite UI for React.
Related to https://github.com/IgniteUI/api-docs/issues/77
Additional information (check all that apply):
Checklist:
README.MDCHANGELOG.MDupdates for newly added functionality