Add integration test

[kamiazya]

This pull request adds an integration test to the project. The integration test is designed to test the functionality of the TypeDoc plugin with different versions of TypeDoc. The test is run as part of the CI/CD pipeline and helps ensure the stability and compatibility of the plugin.

Summary by CodeRabbit

• New Features
  • Added integration test job to the CI workflow to ensure compatibility with different versions of TypeDoc.
• Refactor
  • Renamed test job to unit_test in the CI workflow for clarity.
• Chores
  • Updated devDependencies in example/package.json to include TypeScript.

[changeset-bot]

🦋 Changeset detected

Latest commit: e1aac83

The changes in this PR will be included in the next version bump.

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[coderabbitai]

Walkthrough

The cicd.yaml has been updated to include a new integration test job, testing the project with various TypeDoc versions. This change entails renaming the existing test job to unit_test and introducing a comprehensive integration testing routine. Additionally, the example/package.json now includes TypeScript as a dev dependency.

Changes

File	Summary
.github/workflows/cicd.yaml	Added integration_test job, renamed test job to unit_test.
example/package.json	Included typescript as a dev dependency.
.changeset/proud-foxes-destroy.md	Documented the patch to include an integration test for typedoc-plugin-mermaid.

Poem

In workflows now, two tests delight,
Integration checks take flight;
Our TypeDoc dances in array,
Through versions, it’s a brighter day.
TypeScript joins the dev parade,
In the heart of examples, changes made.
🐰📜🎉

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 70b7cd5 and 796d276.

Files ignored due to path filters (1)

• pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml

Files selected for processing (3)

• .changeset/proud-foxes-destroy.md (1 hunks)
• .github/workflows/cicd.yaml (1 hunks)
• example/package.json (1 hunks)

Files skipped from review due to trivial changes (2)

• .changeset/proud-foxes-destroy.md
• example/package.json

Additional comments not posted (7)

.github/workflows/cicd.yaml (7)

85-89: Job integration_test is well-defined.

The job name and runner are correctly specified. The permissions are appropriately set to read-only.

---

90-98: Matrix strategy is correctly set up.

The matrix includes multiple typedoc versions and fail-fast is set to False, ensuring comprehensive testing.

---

99-99: Correct dependency on the build job.

The integration_test job correctly depends on the build job.

---

101-102: Correct checkout step.

The checkout step uses the correct action with a specific commit hash for consistency.

---

103-104: Setup step is correctly defined.

The setup step uses a local action, which is consistent with other jobs in the workflow.

---

105-105: Correct artifact download step.

The artifact download step uses the correct action with a specific commit hash for consistency.

---

106-110: TypeDoc integration test steps are well-defined.

The steps for adding the typedoc version and running the documentation generation command are correctly specified. Ensure that the pnpm doc command is appropriate for running the integration test.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 796d276 and e1aac83.

Files selected for processing (1)

• .github/workflows/cicd.yaml (2 hunks)

Files skipped from review as they are similar to previous changes (1)

• .github/workflows/cicd.yaml