Group read+build+upload into one linkable block; rename script#2
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (3)
✅ Files skipped from review due to trivial changes (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughDocumentation refocused as an "example-typescript-packaging" guide describing packaging with Changes
Sequence Diagram(s)sequenceDiagram
participant CLI as CLI Script (src/index.ts)
participant API as App API Server
participant FS as Local FS / Packager
participant Runner as Remote Runner / Logs
CLI->>API: create typed OpenAPI client
CLI->>API: GET /apps/{name}?runs=0&timezone=UTC
alt 404 Not Found
CLI->>API: POST /apps { is_externally_accessible: false }
API-->>CLI: 201 Created
else 200 OK
API-->>CLI: 200 App metadata
end
CLI->>FS: read files, build deterministic tar.gz
CLI->>API: POST /deploy (upload package)
API-->>CLI: 200 Deployment accepted
CLI->>API: POST /runs (start run)
API-->>Runner: stream logs
Runner-->>CLI: streamed logs output
Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 3 | ❌ 2❌ Failed checks (2 warnings)
✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Comment |
83fc4f6 to
0b27ba8
Compare
0b27ba8 to
e9b5677
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
README.md (1)
49-50: Prefer a stable link over line-number anchors.The
src/index.ts#L49-L97anchor is brittle and can break on future edits. Linking to the file (or a section heading) is more durable.Suggested fix
-exists, [read the files, build the bundle with `tower-package-wasm`, and -upload them to the deploy endpoint](src/index.ts#L49-L97), then run the +exists, [read the files, build the bundle with `tower-package-wasm`, and +upload it to the deploy endpoint](src/index.ts), then run the app and stream its output.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` around lines 49 - 50, Replace the brittle line-number anchor in the README link (currently pointing to src/index.ts#L49-L97) with a stable link to the file or to a specific section heading in src/index.ts; update the link text to point to src/index.ts (or a named heading/identifier in that file) instead of using L49-L97 so future edits won't break the reference.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- Around line 39-46: The fenced output block in README.md is missing a language
specifier and triggers MD040; update the triple-backtick fence for the shown
block (the multiline output starting with Created app "test-typescript-deploys".
and ending with Run `#1` complete.) to include a language token such as text
(e.g., ```text) so the code fence becomes a labeled block and resolves the lint
warning.
---
Nitpick comments:
In `@README.md`:
- Around line 49-50: Replace the brittle line-number anchor in the README link
(currently pointing to src/index.ts#L49-L97) with a stable link to the file or
to a specific section heading in src/index.ts; update the link text to point to
src/index.ts (or a named heading/identifier in that file) instead of using
L49-L97 so future edits won't break the reference.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 56096d46-c531-448a-9f22-7d4603385cba
📒 Files selected for processing (2)
README.mdsrc/index.ts
| ``` | ||
| Created app "test-typescript-deploys". | ||
| Built package: 360 bytes, 1 app file(s). | ||
| Deployed app "test-typescript-deploys" version v1. | ||
| Started run #1. | ||
| hello from test-typescript-deploys | ||
| Run #1 complete. | ||
| ``` |
There was a problem hiding this comment.
Add a language to the fenced output block.
At Line 39, the fence has no language and triggers MD040.
Suggested fix
-```
+```text
Created app "test-typescript-deploys".
Built package: 360 bytes, 1 app file(s).
Deployed app "test-typescript-deploys" version v1.
Started run `#1`.
hello from test-typescript-deploys
Run `#1` complete.</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.22.1)
[warning] 39-39: 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 `@README.md` around lines 39 - 46, The fenced output block in README.md is
missing a language specifier and triggers MD040; update the triple-backtick
fence for the shown block (the multiline output starting with Created app
"test-typescript-deploys". and ending with Run `#1` complete.) to include a
language token such as text (e.g., ```text) so the code fence becomes a labeled
block and resolves the lint warning.
e9b5677 to
0becec1
Compare
Reorders the script so reading the files, building the bundle, and uploading sit together as a single block a reader can link to — so the README can point at one contiguous demonstration of using
tower-package-wasmend-to-end.Also renames the npm script to
deploy-and-run(it runs the app and streams logs, not just deploys) and retitles the README to match the repo name.Summary by CodeRabbit
deploy→deploy-and-run(command behavior unchanged)