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

withroka · Feb 28, 2025 · 5d290c0 · 5d290c0
1 parent 283f38c
commit 5d290c0
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 1 deletion.
diff --git a/tool/forge/bump.ts b/tool/forge/bump.ts
@@ -42,6 +42,11 @@ export interface BumpOptions {
  *
  * The calculated version is based on {@linkcode Package.update}, dropping
  * pre-release and build information.
+ *
+ * When working with pull requests, if there is an open one for a bump, it will
+ * be updated with the new version information.
+ *
+ * @todo Recalculate versions when the bump PR is rebased.
  */
 export async function bump(
   packages: Package[],

diff --git a/tool/forge/release.ts b/tool/forge/release.ts
@@ -40,7 +40,14 @@ export interface ReleaseOptions {
   draft?: boolean;
 }
 
-/** Create a GitHub release from package. */
+/**
+ * Create a GitHub release from package.
+ *
+ * If a release already exists for the same module and version, it will be
+ * updated.
+ *
+ * @todo Calculate changelog from the exact commit that introduced the version.
+ */
 export async function release(
   pkg: Package,
   options?: ReleaseOptions,