-
Notifications
You must be signed in to change notification settings - Fork 558
Swap flub generate changelog and flub vnext generate changelog implementations, move old to legacy
#25909
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
Co-authored-by: tylerbutler <[email protected]>
flub generate changelog and flub vnext generate changelog implementations
tylerbutler
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You need to do a full build to regenerate documentation.
| * The reason we use a search/replace approach to update the version strings in the changelogs is largely because of | ||
| * https://github.com/changesets/changesets/issues/595. What we would like to do is generate the changelogs without | ||
| * doing version bumping, but that feature does not exist in the changeset tools. | ||
| * @deprecated This command is deprecated. Use 'flub generate changelog' instead. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| * @deprecated This command is deprecated. Use 'flub generate changelog' instead. | |
| * Generate a changelog for packages based on changesets. Note that this process deletes the changeset files! | |
| * | |
| * The reason we use a search/replace approach to update the version strings in the changelogs is largely because of | |
| * https://github.com/changesets/changesets/issues/595. What we would like to do is generate the changelogs without | |
| * doing version bumping, but that feature does not exist in the changeset tools. | |
| * | |
| * @deprecated This command is deprecated. Use 'flub generate changelog' instead. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated the JSDoc comment to include the comprehensive documentation about the changelog generation process. Commit: 736cf72
|
@copilot Address this feedback: #25909 (review) |
|
@copilot On second thought move the old command to be 'flub deprecated' instead of 'flub vnext'. |
…t command Co-authored-by: tylerbutler <[email protected]>
I've addressed the feedback by:
The documentation has been regenerated to show:
Commit: 736cf72 |
Co-authored-by: tylerbutler <[email protected]>
Moved the old command implementation from Changes made:
Commit: f7b0cc2 |
flub generate changelog and flub vnext generate changelog implementationsflub generate changelog and flub vnext generate changelog implementations, move old to deprecated
|
/azp run Build - protocol-definitions,Build - test-tools,server-gitrest,server-gitssh,server-historian,server-routerlicious,Build - client packages,repo-policy-check |
|
/azp run Build - api-markdown-documenter,Build - benchmark-tool,Build - build-common,Build - build-tools,Build - common-utils,Build - eslint-config-fluid,Build - eslint-plugin-fluid |
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
@copilot Leave the vnext command in place but mark it deprecated as well using the command's deprecated propery, and explain that the main command is now to be used. And instead of deprecated, use "legacy" as the directory for the deprecated command. |
|
@copilot You need to do a full build in build-tools and commit the generated changes too. |
Co-authored-by: tylerbutler <[email protected]>
Completed the requested changes:
The command structure is now:
Commit: 4fded1e |
flub generate changelog and flub vnext generate changelog implementations, move old to deprecatedflub generate changelog and flub vnext generate changelog implementations, move old to legacy
Co-authored-by: tylerbutler <[email protected]>
Built the build-tools workspace and regenerated the documentation:
The auto-generated documentation now reflects the current command structure with proper deprecation warnings. Commit: a0c118c |
Description
Swaps the implementations of
flub generate changelogandflub vnext generate changelog. The vnext implementation (newer infrastructure usingBaseCommandWithBuildProject) becomes the main command. The old main implementation (legacyBaseCommandwith inline git operations) is moved to the newflub legacynamespace and marked deprecated. The vnext command is kept in place as a deprecated wrapper pointing to the main command.Changes:
commands/generate/changelog.ts): Now usesBaseCommandWithBuildProject,updateChangelogs()library function, andsetVersion()from@fluid-tools/build-infrastructurecommands/vnext/generate/changelog.ts): Kept in place as deprecated wrapper using same new infrastructure as main command; marked with comprehensive@deprecatedJSDoc comment explaining the deprecation,deprecatedproperty, and[DEPRECATED]prefix in description directing users to use main commandcommands/legacy/generate/changelog.ts): Now contains old implementation with inlineprocessPackage()and git operations; marked with comprehensive@deprecatedJSDoc comment explaining the deprecation,deprecatedproperty, and[DEPRECATED]prefix in descriptiondocs/generate.mdto reflect new main command implementationdocs/vnext.mdto include deprecated changelog command with deprecation warningsdocs/legacy.mdfor legacy commandsREADME.mdto include link to legacy commands documentationpackage.jsonUsers of both
flub vnext generate changelogandflub legacy generate changelogwill see deprecation warnings directing them to use the main command.Breaking Changes
None. All three commands remain functional. The vnext and legacy commands are marked as deprecated but not removed.
Reviewer Guidance
Verify that:
legacynamespace with old infrastructure../../../instead of../../)Original prompt
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.