Skip to content
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

docs(forge): add behavior and todos for edge cases #75

Merged
merged 1 commit into from
Feb 28, 2025

Conversation

tugrulates
Copy link
Member

No description provided.

@Copilot Copilot bot review requested due to automatic review settings February 28, 2025 08:59
@github-actions github-actions bot added the forge label Feb 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PR Overview

This PR updates the documentation for GitHub release creation and package version bump operations to better describe the behavior in edge cases. It also adds TODOs to track future improvements.

  • Updated the doc comment in release.ts to clarify that an existing release will be updated and to include a TODO for calculating a changelog.
  • Enhanced the doc comment in bump.ts to note that an open bump PR will be updated and added a TODO for version recalculation when the bump PR is rebased.

Reviewed Changes

File Description
tool/forge/release.ts Updated the function documentation to reflect release update behavior and to add a changelog TODO.
tool/forge/bump.ts Updated the function documentation to reflect behavior for updating open bump PRs and added a version recalculation TODO.

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

Comments suppressed due to low confidence (2)

tool/forge/release.ts:46

  • Consider adding tests to verify that an existing release is updated correctly as described in the documentation.
 * If a release already exists for the same module and version, it will be

tool/forge/bump.ts:46

  • Consider adding tests to ensure that an open bump PR is updated with the new version information, as noted in the documentation.
 * When working with pull requests, if there is an open one for a bump, it will
@tugrulates tugrulates merged commit 5d290c0 into main Feb 28, 2025
10 checks passed
@tugrulates tugrulates deleted the docs/forge/todo branch February 28, 2025 09:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant