Conversation
dosubot
bot
added
the
size:L
📝 WalkthroughWalkthroughAdds Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
🎨 Storybook:
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
docs/release-process.md (1)
15-20: Add language specifications to fenced code blocks.The ASCII diagrams are missing language identifiers. Adding
textorplaintextafter the opening backticks improves markdown rendering and satisfies linter requirements.📝 Proposed fix for code block language specifications
For lines 15-20:
-``` +```text main: ──A──B──C──D──[bump to 1.42.0]──E──F──G── ... │ ├── core/1.41 (branched from D) └── cloud/1.41 (branched from D)**For lines 51-53:** ```diff -``` +```text v1.40.1 ── A ── B ── C ── [bump to 1.41.0]</details> Also applies to: 51-53 <details> <summary>🤖 Prompt for AI Agents</summary>Verify each finding against the current code and only fix it if needed.
In
@docs/release-process.mdaround lines 15 - 20, The fenced ASCII diagram code
blocks in the release-process doc lack language identifiers; update the opening
backticks for the two diagrams (the block showing the main/core/cloud branch
diagram containing "main: ──A──B──C..." and the smaller "v1.40.1 ── A ── B ── C
..." block) to include a plain text language tag (e.g., change "" to "text" or "```plaintext") so markdown renders them as plain text and
satisfies the linter.</details> </blockquote></details> </blockquote></details> <details> <summary>🤖 Prompt for all review comments with AI agents</summary>Verify each finding against the current code and only fix it if needed.
Inline comments:
In@docs/release-process.md:
- Around line 84-89: Update the npm package name entry in the release process
docs: replace the incorrect package string@comfyorg/comfyui-frontend-typesin
the "Channel | Package" table with the correct@comfyorg/comfyui-frontend,
leaving the rest of the table (GitHub Releasesdist.zipand PyPI
comfyui-frontend-package) unchanged.
Nitpick comments:
In@docs/release-process.md:
- Around line 15-20: The fenced ASCII diagram code blocks in the release-process
doc lack language identifiers; update the opening backticks for the two diagrams
(the block showing the main/core/cloud branch diagram containing "main:
──A──B──C..." and the smaller "v1.40.1 ── A ── B ── C ..." block) to include a
plain text language tag (e.g., change "" to "text" or "```plaintext") so
markdown renders them as plain text and satisfies the linter.</details> --- <details> <summary>ℹ️ Review info</summary> <details> <summary>⚙️ Run configuration</summary> **Configuration used**: Path: .coderabbit.yaml **Review profile**: CHILL **Plan**: Pro **Run ID**: `ea7e630c-aea2-4337-bf60-fd8cf1c0acb3` </details> <details> <summary>📥 Commits</summary> Reviewing files that changed from the base of the PR and between c4156d705999dec1104608e606d8bb50b23aa873 and af9cb5b4f3026b18fd8f8b75a58cb4de2ca6f634. </details> <details> <summary>📒 Files selected for processing (1)</summary> * `docs/release-process.md` </details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
docs/release-process.md
Outdated
| | Channel | Package | | ||
| |---|---| | ||
| | GitHub Releases | `dist.zip` | | ||
| | PyPI | `comfyui-frontend-package` | | ||
| | npm | `@comfyorg/comfyui-frontend-types` | | ||
|
|
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Description: Verify package names match repository configuration
echo "Checking npm package name..."
if [ -f "package.json" ]; then
npm_name=$(jq -r '.name' package.json)
echo "Found in package.json: $npm_name"
if [ "$npm_name" = "@comfyorg/comfyui-frontend-types" ]; then
echo "✓ npm package name matches documentation"
else
echo "⚠ npm package name differs from documentation"
fi
fi
echo ""
echo "Checking PyPI package name..."
for pyfile in pyproject.toml setup.py setup.cfg; do
if [ -f "$pyfile" ]; then
echo "Found: $pyfile"
case "$pyfile" in
pyproject.toml)
if grep -q "name.*comfyui-frontend-package" "$pyfile"; then
echo "✓ PyPI package name matches documentation"
else
echo "PyPI package name in $pyfile:"
grep "name" "$pyfile" | head -1
fi
;;
setup.py)
if grep -q "name.*comfyui-frontend-package" "$pyfile"; then
echo "✓ PyPI package name matches documentation"
else
echo "PyPI package name in $pyfile:"
grep "name" "$pyfile" | head -1
fi
;;
esac
fi
doneRepository: Comfy-Org/ComfyUI_frontend
Length of output: 225
🏁 Script executed:
# Find configuration files related to PyPI/Python packaging
find . -type f \( -name "pyproject.toml" -o -name "setup.py" -o -name "setup.cfg" -o -name "*.toml" \) 2>/dev/null | head -20Repository: Comfy-Org/ComfyUI_frontend
Length of output: 105
🏁 Script executed:
# Search for references to the PyPI package name in the repository
rg "comfyui-frontend-package" --type md --type txt --type toml --type yaml -iRepository: Comfy-Org/ComfyUI_frontend
Length of output: 296
🏁 Script executed:
# Check if there's a separate types package or verify npm package details
cat package.json | jq '.description, .version, .keywords' 2>/dev/nullRepository: Comfy-Org/ComfyUI_frontend
Length of output: 130
🏁 Script executed:
cat ./comfyui_frontend_package/setup.py | head -30Repository: Comfy-Org/ComfyUI_frontend
Length of output: 347
Fix the npm package name in the documentation.
The npm package name should be @comfyorg/comfyui-frontend, not @comfyorg/comfyui-frontend-types. The -types suffix does not exist in the actual package.json. The PyPI package name comfyui-frontend-package is correct.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/release-process.md` around lines 84 - 89, Update the npm package name
entry in the release process docs: replace the incorrect package string
`@comfyorg/comfyui-frontend-types` in the "Channel | Package" table with the
correct `@comfyorg/comfyui-frontend`, leaving the rest of the table (GitHub
Releases `dist.zip` and PyPI `comfyui-frontend-package`) unchanged.
There was a problem hiding this comment.
Actionable comments posted: 2
♻️ Duplicate comments (1)
docs/release-process.md (1)
88-92:⚠️ Potential issue | 🟡 MinorFix the npm package name in the documentation.
The npm package name should be
@comfyorg/comfyui-frontend, not@comfyorg/comfyui-frontend-types. This issue was previously identified and remains unresolved.📝 Proposed fix
| Channel | Package | |---|---| | GitHub Releases | `dist.zip` | | PyPI | `comfyui-frontend-package` | -| npm | `@comfyorg/comfyui-frontend-types` | +| npm | `@comfyorg/comfyui-frontend` |🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/release-process.md` around lines 88 - 92, The npm package name in the release channel table is incorrect: locate the "Channel | Package" markdown table (the npm row) and replace the package string '@comfyorg/comfyui-frontend-types' with the correct '@comfyorg/comfyui-frontend' so the npm entry reads the correct package name.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/release-process.md`:
- Around line 15-20: The fenced diagram block in docs/release-process.md is
missing a language specifier; update the opening triple-backtick for the block
that contains the branch diagram (the block starting with "main:
──A──B──C──D──[bump to 1.42.0]──E──F──G── ...") to include a language tag such
as text (e.g., change ``` to ```text) so markdown renderers apply proper syntax
highlighting and the document is compliant.
- Around line 51-53: Update the fenced code block surrounding the string
"v1.40.1 ── A ── B ── C ── [bump to 1.41.0]" to include a language specifier
(e.g., use ```text instead of ```), so the block is markdown-compliant and
renders with proper syntax highlighting; change the opening backticks only and
keep the content and closing backticks unchanged.
---
Duplicate comments:
In `@docs/release-process.md`:
- Around line 88-92: The npm package name in the release channel table is
incorrect: locate the "Channel | Package" markdown table (the npm row) and
replace the package string '@comfyorg/comfyui-frontend-types' with the correct
'@comfyorg/comfyui-frontend' so the npm entry reads the correct package name.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 74d5cf59-709a-4e8b-9da1-7fc771d5feee
📒 Files selected for processing (1)
docs/release-process.md
docs/release-process.md
Outdated
| ``` | ||
| main: ──A──B──C──D──[bump to 1.42.0]──E──F──G── ... | ||
| │ | ||
| ├── core/1.41 (branched from D) | ||
| └── cloud/1.41 (branched from D) | ||
| ``` |
There was a problem hiding this comment.
Add language specifier to fenced code block.
The fenced code block should include a language identifier for proper syntax highlighting and markdown compliance.
📝 Proposed fix
-```
+```text
main: ──A──B──C──D──[bump to 1.42.0]──E──F──G── ...
│
├── core/1.41 (branched from D)
└── cloud/1.41 (branched from D)</details>
<!-- suggestion_start -->
<details>
<summary>📝 Committable suggestion</summary>
> ‼️ **IMPORTANT**
> Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
```suggestion
🧰 Tools
🪛 markdownlint-cli2 (0.21.0)
[warning] 15-15: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/release-process.md` around lines 15 - 20, The fenced diagram block in
docs/release-process.md is missing a language specifier; update the opening
triple-backtick for the block that contains the branch diagram (the block
starting with "main: ──A──B──C──D──[bump to 1.42.0]──E──F──G── ...") to include
a language tag such as text (e.g., change ``` to ```text) so markdown renderers
apply proper syntax highlighting and the document is compliant.
| ``` | ||
| v1.40.1 ── A ── B ── C ── [bump to 1.41.0] | ||
| ``` |
There was a problem hiding this comment.
Add language specifier to fenced code block.
The fenced code block should include a language identifier for proper syntax highlighting and markdown compliance.
📝 Proposed fix
-```
+```text
v1.40.1 ── A ── B ── C ── [bump to 1.41.0]</details>
<details>
<summary>🧰 Tools</summary>
<details>
<summary>🪛 markdownlint-cli2 (0.21.0)</summary>
[warning] 51-51: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
</details>
</details>
<details>
<summary>🤖 Prompt for AI Agents</summary>
Verify each finding against the current code and only fix it if needed.
In @docs/release-process.md around lines 51 - 53, Update the fenced code block
surrounding the string "v1.40.1 ── A ── B ── C ── [bump to 1.41.0]" to include a
language specifier (e.g., use text instead of ), so the block is
markdown-compliant and renders with proper syntax highlighting; change the
opening backticks only and keep the content and closing backticks unchanged.
</details>
<!-- fingerprinting:phantom:triton:puma -->
<!-- This is an auto-generated comment by CodeRabbit -->
There was a problem hiding this comment.
♻️ Duplicate comments (2)
docs/release-process.md (2)
25-29:⚠️ Potential issue | 🟡 MinorAdd a language tag to this fenced block.
This still triggers MD040 on Line 25.
Suggested fix
-``` +```text v1.40.1 ── A ── B ── C ── [bump to 1.41.0] │ └── core/1.40</details> <details> <summary>🤖 Prompt for AI Agents</summary>Verify each finding against the current code and only fix it if needed.
In
@docs/release-process.mdaround lines 25 - 29, The fenced code block starting
withand containing the release graph (the lines beginning "v1.40.1 ── A ── B ── C ── [bump to 1.41.0]") lacks a language tag and triggers MD040; fix it by adding a language tag (e.g., "text") to the opening backticks so the block becomestext, ensuring the linter no longer flags the block.</details> --- `43-45`: _⚠️ Potential issue_ | _🟡 Minor_ **Fix the npm package name in the publishing section.** Line 45 still points to `@comfyorg/comfyui-frontend-types`; this guide should reference the actual published npm package instead. <details> <summary>Suggested fix</summary> ```diff -Merged PRs with the `Release` label trigger `release-draft-create.yaml`, -publishing to GitHub Releases (`dist.zip`), PyPI (`comfyui-frontend-package`), -and npm (`@comfyorg/comfyui-frontend-types`). +Merged PRs with the `Release` label trigger `release-draft-create.yaml`, +publishing to GitHub Releases (`dist.zip`), PyPI (`comfyui-frontend-package`), +and npm (`@comfyorg/comfyui-frontend`). ``` </details> <details> <summary>🤖 Prompt for AI Agents</summary> ``` Verify each finding against the current code and only fix it if needed. In `@docs/release-process.md` around lines 43 - 45, The docs currently list the wrong npm package name (`@comfyorg/comfyui-frontend-types`) in the publishing sentence; update that reference to the actual published npm package used by the release workflow (the package published by release-draft-create.yaml) and ensure the sentence mentions the correct npm package alongside dist.zip and comfyui-frontend-package so it matches the release workflow configuration. ``` </details> </blockquote></details> </blockquote></details> <details> <summary>🤖 Prompt for all review comments with AI agents</summary>Verify each finding against the current code and only fix it if needed.
Duplicate comments:
In@docs/release-process.md:
- Around line 25-29: The fenced code block starting with
and containing the release graph (the lines beginning "v1.40.1 ── A ── B ── C ── [bump to 1.41.0]") lacks a language tag and triggers MD040; fix it by adding a language tag (e.g., "text") to the opening backticks so the block becomestext, ensuring the
linter no longer flags the block.- Around line 43-45: The docs currently list the wrong npm package name
(@comfyorg/comfyui-frontend-types) in the publishing sentence; update that
reference to the actual published npm package used by the release workflow (the
package published by release-draft-create.yaml) and ensure the sentence mentions
the correct npm package alongside dist.zip and comfyui-frontend-package so it
matches the release workflow configuration.</details> --- <details> <summary>ℹ️ Review info</summary> <details> <summary>⚙️ Run configuration</summary> **Configuration used**: Path: .coderabbit.yaml **Review profile**: CHILL **Plan**: Pro **Run ID**: `31a00f3c-16f4-4942-850a-e6defa51a669` </details> <details> <summary>📥 Commits</summary> Reviewing files that changed from the base of the PR and between bd505332c02ae249dde17ed054bc24a602a4179f and c3169f71911645cf41bbaa8f1c97d02ac596efd6. </details> <details> <summary>📒 Files selected for processing (1)</summary> * `docs/release-process.md` </details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
Adds a concise guide to `docs/release-process.md` explaining how the release workflows interact, with focus on the version semantics that differ between minor and patch bumps. Key sections: - How minor bumps freeze the previous minor into `core/` and `cloud/` branches - How patch bumps on `main` vs `core/X.Y` differ (published vs draft releases) - Why unreleased commits are dual-homed when a minor bump happens - Summary table, backporting, publishing, and bi-weekly automation ┆Issue is synchronized with this [Notion page](https://www.notion.so/PR-9548-docs-add-release-process-guide-31d6d73d365081f2bdaace48a7cb81ae) by [Unito](https://www.unito.io) --------- Co-authored-by: Alexander Brown <drjkl@comfy.org>
2 participants
Adds a concise guide to
docs/release-process.mdexplaining how the release workflows interact, with focus on the version semantics that differ between minor and patch bumps.Key sections:
core/andcloud/branchesmainvscore/X.Ydiffer (published vs draft releases)┆Issue is synchronized with this Notion page by Unito