doc: add instructions to create new reference project and run it locally #1417
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
WalkthroughThe changes in the Changes
Assessment against linked issues
Possibly related PRs
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (5)
references/README.md (5)
55-67: Minor improvements for clarity and consistency.The instructions for setting up and running ngrok are clear and detailed. However, there are a couple of minor issues to address:
- Grammar: Use "an" instead of "a" before "http tunnel" in lines 55 and 56.
- Code blocks: Add language specifications to the code blocks for better syntax highlighting.
Here's a suggested fix for the grammar:
-1. **Run a http tunnel**: -You will need to run a http tunnel to expose your local webapp, it is required for some API calls during building the image to deploy on your local instance. +1. **Run an HTTP tunnel**: +You will need to run an HTTP tunnel to expose your local webapp, it is required for some API calls during building the image to deploy on your local instance.For the code blocks, add the language specification like this:
-``` +```bash ngrok config add-authtoken <your-auth-token>-
+bash
ngrok http🧰 Tools
🪛 LanguageTool
[misspelling] ~55-~55: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...### Step-by-Step Instructions 1. Run a http tunnel: You will need to run a h...(EN_A_VS_AN)
[misspelling] ~56-~56: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...n a http tunnel**: You will need to run a http tunnel to expose your local webapp...(EN_A_VS_AN)
🪛 Markdownlint
59-59: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
64-64: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
73-77: Add language specification to code block.The command for running the webapp locally is correct and includes all necessary components. To improve readability and enable syntax highlighting, consider adding a language specification to the code block.
Here's the suggested change:
-``` +```bash pnpm run dev --filter webapp --filter coordinator --filter docker-provider<details> <summary>🧰 Tools</summary> <details> <summary>🪛 Markdownlint</summary><blockquote> 75-75: null Fenced code blocks should have a language specified (MD040, fenced-code-language) </blockquote></details> </details> --- `79-87`: **Add language specifications to code blocks.** The instructions for building the CLI and making it accessible are clear and comprehensive. To improve readability and enable syntax highlighting, consider adding language specifications to the code blocks. Here's the suggested change: ```diff -``` +```bash # Build the CLI pnpm run build --filter trigger.dev # Make it accessible to `pnpm exec` pnpm i<details> <summary>🧰 Tools</summary> <details> <summary>🪛 Markdownlint</summary><blockquote> 81-81: null Fenced code blocks should have a language specified (MD040, fenced-code-language) </blockquote></details> </details> --- `94-100`: **Add language specification to code block.** The instructions for copying the hello-world project as a template are clear and include a placeholder for the new project name. To improve readability and enable syntax highlighting, consider adding a language specification to the code block. Here's the suggested change: ```diff -``` +```bash cp -r references/hello-world references/<new-project><details> <summary>🧰 Tools</summary> <details> <summary>🪛 Markdownlint</summary><blockquote> 96-96: null Fenced code blocks should have a language specified (MD040, fenced-code-language) </blockquote></details> </details> --- `110-127`: **LGTM: Clear instructions for CLI authorization and project execution. Minor formatting suggestion.** The instructions for authorizing the CLI, running, and deploying the project are clear and comprehensive. These steps align well with the PR objectives of running and deploying a reference project locally. To improve readability and enable syntax highlighting, consider adding language specifications to the code blocks. Here are the suggested changes: ```diff -``` +```bash pnpm exec trigger login -a http://localhost:3030 --profile local-
+bash
pnpm exec trigger dev --profile local-``` +```bash pnpm exec trigger deploy --self-hosted --load-image --profile local<details> <summary>🧰 Tools</summary> <details> <summary>🪛 Markdownlint</summary><blockquote> 112-112: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 119-119: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 125-125: null Fenced code blocks should have a language specified (MD040, fenced-code-language) </blockquote></details> </details> </blockquote></details> </blockquote></details> <details> <summary>📜 Review details</summary> **Configuration used: CodeRabbit UI** **Review profile: CHILL** <details> <summary>📥 Commits</summary> Files that changed from the base of the PR and between ef7f11222709f30c9f3da7c3c1d41bf099cd8d9e and dd2a2ac6a56e7d13b76fe0f45441f5827b5a0c15. </details> <details> <summary>📒 Files selected for processing (1)</summary> * references/README.md (1 hunks) </details> <details> <summary>🧰 Additional context used</summary> <details> <summary>🪛 LanguageTool</summary><blockquote> <details> <summary>references/README.md</summary><blockquote> [misspelling] ~55-~55: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’. Context: ...### Step-by-Step Instructions 1. **Run a http tunnel**: You will need to run a h... (EN_A_VS_AN) --- [misspelling] ~56-~56: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’. Context: ...n a http tunnel**: You will need to run a http tunnel to expose your local webapp... (EN_A_VS_AN) </blockquote></details> </blockquote></details> <details> <summary>🪛 Markdownlint</summary><blockquote> <details> <summary>references/README.md</summary><blockquote> 59-59: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 64-64: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 75-75: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 81-81: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 96-96: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 112-112: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 119-119: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 125-125: null Fenced code blocks should have a language specified (MD040, fenced-code-language) </blockquote></details> </blockquote></details> </details> <details> <summary>🔇 Additional comments (5)</summary><blockquote> <details> <summary>references/README.md (5)</summary><blockquote> `49-51`: **LGTM: Clear introduction and prerequisite reference.** The introduction clearly states the purpose of the new section and appropriately references the Contributing.md file for initial setup. This aligns well with the PR objective and helps ensure users have the necessary local environment set up before proceeding. --- `69-71`: **LGTM: Clear instructions for environment setup.** The instructions for updating the APP_ORIGIN variable in the .env file are clear and concise. This step is crucial for the local setup and aligns well with the PR objectives. --- `89-93`: **LGTM: Clear instructions for project setup in webapp.** The instructions for setting up a new project in the webapp are clear, concise, and align well with the PR objectives. This step is crucial for creating a new reference project. --- `102-108`: **LGTM: Comprehensive instructions for project configuration.** The instructions for updating project details are clear, comprehensive, and cover all necessary updates (package.json, trigger.config.ts, and syncing dependencies). This step aligns well with the PR objectives of creating a new reference project. --- `49-127`: **Excellent addition of comprehensive instructions for creating a new reference project.** The new section "Creating a New Reference Project" successfully addresses the documentation gap outlined in issue #1362. The instructions are clear, detailed, and cover all aspects of creating, running, and deploying a new reference project locally. This includes: 1. Setting up the local environment with ngrok 2. Configuring the project in the webapp 3. Copying and customizing the template project 4. Building and authorizing the CLI 5. Running and deploying the project locally The step-by-step guide aligns perfectly with the PR objectives and provides valuable assistance to new contributors. The minor suggestions for grammar and code block formatting will further enhance the readability of the document. Great job on improving the documentation! <details> <summary>🧰 Tools</summary> <details> <summary>🪛 LanguageTool</summary><blockquote> [misspelling] ~55-~55: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’. Context: ...### Step-by-Step Instructions 1. **Run a http tunnel**: You will need to run a h... (EN_A_VS_AN) --- [misspelling] ~56-~56: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’. Context: ...n a http tunnel**: You will need to run a http tunnel to expose your local webapp... (EN_A_VS_AN) </blockquote></details> <details> <summary>🪛 Markdownlint</summary><blockquote> 59-59: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 64-64: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 75-75: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 81-81: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 96-96: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 112-112: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 119-119: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 125-125: null Fenced code blocks should have a language specified (MD040, fenced-code-language) </blockquote></details> </details> </blockquote></details> </blockquote></details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
ericallam
approved these changes
Oct 18, 2024
nicktrn
pushed a commit
that referenced
this pull request
Oct 22, 2024
…lly (#1417) * doc: add instructions to create new reference project and run it locally * doc: Add instruction for running tunnel * minor language improvement
nicktrn
added a commit
that referenced
this pull request
Oct 24, 2024
* refactor finalize run service * refactor complete attempt service * remove separate graceful exit handling * refactor task status helpers * clearly separate statuses in prisma schema * all non-final statuses should be failable * new import payload error code * store default retry config if none set on task * failed run service now respects retries * fix merged task retry config indexing * some errors should never be retried * finalize run service takes care of acks now * execution payload helper now with single object arg * internal error code enum export * unify failed and crashed run retries * Prevent uncaught socket ack exceptions (#1415) * catch all the remaining socket acks that could possibly throw * wrap the remaining handlers in try catch * New onboarding question (#1404) * Updated “Twitter” to be “X (Twitter)” * added Textarea to storybook * Updated textarea styling to match input field * WIP adding new text field to org creation page * Added description to field * Submit feedback to Plain when an org signs up * Formatting improvement * type improvement * removed userId * Moved submitting to Plain into its own file * Change orgName with name * use sendToPlain function for the help & feedback email form * use name not orgName * import cleanup * Downgrading plan form uses sendToPlain * Get the userId from requireUser only * Added whitespace-pre-wrap to the message property on the run page * use requireUserId * Removed old Plain submit code * Added a new Context page for the docs (#1416) * Added a new context page with task context properties * Removed code comments * Added more crosslinks * Fix updating many environment variables at once (#1413) * Move code example to the side menu * New docs example for creating a HN email summary * doc: add instructions to create new reference project and run it locally (#1417) * doc: add instructions to create new reference project and run it locally * doc: Add instruction for running tunnel * minor language improvement * Fix several restore and resume bugs (#1418) * try to correct resume messages with missing checkpoint * prevent creating checkpoints for outdated task waits * prevent creating checkpoints for outdated batch waits * use heartbeats to check for and clean up any leftover containers * lint * improve exec logging * improve resume attempt logs * fix for resuming parents of canceled child runs * separate SIGTERM from maybe OOM errors * pretty errors can have magic dashboard links * prevent uncancellable checkpoints * simplify task run error code enum export * grab the last, not the first child run * Revert "prevent creating checkpoints for outdated batch waits" This reverts commit f2b5c2a. * Revert "grab the last, not the first child run" This reverts commit 89ec5c8. * Revert "prevent creating checkpoints for outdated task waits" This reverts commit 11066b4. * more logs for resume message handling * add magic error link comment * add changeset * chore: Update version for release (#1410) Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> * Release 3.0.13 * capture ffmpeg oom errors * respect maxAttempts=1 when failing before first attempt creation * request worker exit on fatal errors * fix error code merge * add new error code to should retry * pretty segfault errors * pretty internal errors for attempt spans * decrease oom false positives * fix timeline event color for failed runs * auto-retry packet import and export * add sdk version check and complete event while completing attempt * all internal errors become crashes by default * use pretty error helpers exclusively * error to debug log * zodfetch fixes * rename import payload to task input error * fix true non-zero exit error display * fix retry config parsing * correctly mark crashes as crashed * add changeset * remove non-zero exit comment * pretend we don't support default default retry configs yet --------- Co-authored-by: James Ritchie <[email protected]> Co-authored-by: shubham yadav <[email protected]> Co-authored-by: Tarun Pratap Singh <[email protected]> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #1362
✅ Checklist
Testing
[Describe the steps you took to test this change]
Changelog
[Short description of what has changed]
Screenshots
[Screenshots]
💯
Summary by CodeRabbit
Summary by CodeRabbit
/claim #1362