Model Context Protocols

🚀 Changesets

This directory contains Changesets, which are used to manage version control and changelogs in a monorepo.

🚀 Quick Start

What are Changesets?

Changesets are a way to manage version control and changelogs in a monorepo. They allow you to:

1. Record changes to packages in the repository.
2. Automatically determine the appropriate version number bump (major, minor, patch).
3. Generate changelogs based on the changes.
4. Publish packages to npm.

How to Use Changesets

Adding a Changeset

When you make changes to a package, you should add a changeset to describe those changes:

Run `npm run changeset`

This will prompt you to:

1. Select the packages that have changed (use the space bar to select and enter to confirm).
2. Choose the type of version number bump for each package:
   • major: A significant change.
   • minor: A new feature (non - breaking).
   • patch: Bug fixes and small changes.
3. Write a summary of the changes. This summary will be included in the changelog and displayed when the package is released.

Versioning Packages

When you're ready to release a new version of a package:

Run `npm run version-packages`

This will:

1. Consume all changesets.
2. Update the package versions.
3. Update the changelogs.
4. Create a new commit with these changes.

Publishing Packages

To publish packages to npm:

Run `npm run release`

This will:

1. Build all packages.
2. Publish the packages to npm.

CI/CD Integration

This repository is configured with a GitHub workflow that:

1. Creates a PR with version updates when changesets are added to the main branch.
2. Publishes packages to npm when the PR is merged. This workflow runs automatically when changes are pushed to the main branch.

Best Practices

1. Create Changesets as Needed: Create a changeset every time you make a significant change to make the changelog more detailed and useful.
2. Write Meaningful Changeset Messages: Describe what and why the change was made, not just what happened to the files.
3. Use Appropriate Bump Types:
   • major: Significant breaking changes that require users to update their code.
   • minor: New features that do not break existing functionality.
   • patch: Bug fixes and small changes that do not add new features or break existing code.
4. Review Changesets Before Versioning: Ensure that all changes are correctly recorded before running version-packages.
5. Keep Packages in Sync: For tightly - coupled packages, consider using the fixed option in the configuration to ensure they are always versioned together.

Troubleshooting

• Empty Changeset List: If npm run changeset shows no packages, make sure your packages have a correct package.json file with name and version fields.
• Publishing Errors: If publishing fails, check that you have the correct npm credentials and that the package names are available.
• Merging Conflicts in Changelogs: Resolve conflicts by keeping all entries and fixing any formatting issues.

For more detailed information, refer to the official Changesets documentation.