changelog-generator-wrapper

@fluid-private/changelog-generator-wrapper

This tool is used to transform changesets into CHANGELOG.md entries. It uses the extensibility that the default changesets tools provide, which is documented here: https://github.com/changesets/changesets/blob/main/docs/modifying-changelog-format.md

Unfortunately the APIs are not well documented, so this tool builds on top of another formatter, changesets-format-with-issue-links. The only changes we've made to that formatter is to ignore changelog entries that are only due to dependency updates. The changelog files are then fixed up using a custom tool.

NOTE: This package is private to the @microsoft/fluid-framework repository. This package is not published. Use it only in packages in the same pnpm workspace. Specify workspace:* as the version. Use this package only as a development dependency or as a dependency of an unpublished package.

Generating changelogs for release

To generate changelogs for a release, use the steps below. These instructions assume @fluid-internal/changelog-generator has been built, which should happen automatically when running pnpm i in the root.

1. Run pnpm i from the repo root.
2. Run pnpm flub changelog generate --releaseGroup client
3. Commit and open a PR!

For more information see the build-cli documentation.

Developer notes

This package is written in JS instead of TypeScript primarily so it doesn't need to be compiled before use. The code is a wrapper around other implementations, so the code is simple and doesn't benefit much from typing.

Contribution Guidelines

You can contribute to Fluid Framework in these ways:

• Answer questions in GitHub Discussions.
• Submit bug reports and help verify fixes.
• Review source code changes.
• Contribute bug fixes.

For detailed instructions, read the repo documentation.

This project follows the Microsoft Open Source Code of Conduct. For more information, read the Code of Conduct frequently asked questions. For questions or comments, contact opencode@microsoft.com.

This project may contain Microsoft trademarks or logos for Microsoft projects, products, or services. Use of these trademarks or logos must follow Microsoft’s Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.

Help

Read the Fluid Framework documentation for information about Fluid Framework concepts and APIs.

To request information that the documentation does not contain, create an issue.

Trademark

This project may contain Microsoft trademarks or logos for Microsoft projects, products, or services.

Use of these trademarks or logos must follow Microsoft's Trademark & Brand Guidelines.

Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.