Skip to content

New Doc: create your own build extension reference #1347

New issue

Have a question about this project? No Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “No 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? No Sign in to your account

Merged
merged 2 commits into from
Sep 23, 2024

Conversation

ericallam
Copy link
Member

@ericallam ericallam commented Sep 23, 2024

Add a guide and reference for creating your own build extension.

Summary by CodeRabbit

  • Documentation
    • Updated sidebar title for "The trigger.config.ts file" for improved clarity.
    • Transformed the "Overview" document into a detailed guide on building extensions, including new sections and methods for project customization.
    • Removed the prisma.mdx file, eliminating associated configuration settings for the Prisma extension.
    • Enhanced formatting in docs/mint.json for improved readability without changing content.

Copy link

changeset-bot bot commented Sep 23, 2024

⚠️ No Changeset found

Latest commit: 069e087

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Contributor

coderabbitai bot commented Sep 23, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request introduces several changes across multiple documentation files. Notably, it modifies the sidebar title of the "trigger.config.ts" document for clarity, transforms the "Overview" document into a comprehensive guide for building extensions, and removes the now-obsolete "prisma.mdx" file. Additionally, formatting adjustments are made in the docs/mint.json file to enhance readability without altering the content.

Changes

File Path Change Summary
docs/config/config-file.mdx Updated sidebarTitle from "Configuration" to "trigger.config.ts."
docs/config/extensions/overview.mdx Transformed from an overview to a detailed guide on building extensions, with new methods and types added.
docs/config/extensions/prisma.mdx Deleted file containing configuration for the Prisma extension.
docs/mint.json Reformatted JSON structure for improved readability, no content changes.

Possibly related PRs

Poem

🐇 In the garden of docs, changes bloom bright,
Titles and guides now feel just right.
Extensions to build, with hooks to explore,
A missing file gone, but knowledge will soar.
With each little tweak, clarity grows,
Hopping along, where the documentation flows! 🌼


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?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    -- I pushed a fix in commit <commit_id>, please review it.
    -- Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    -- @coderabbitai generate unit testing code for this file.
    -- @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    -- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    -- @coderabbitai read src/utils.ts and generate unit testing code.
    -- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    -- @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@ericallam ericallam merged commit 3772b5a into main Sep 23, 2024
8 of 9 checks passed
Copy link

pkg-pr-new bot commented Sep 23, 2024

pnpm add https://pkg.pr.new/triggerdotdev/trigger.dev/@trigger.dev/build@1347
pnpm add https://pkg.pr.new/triggerdotdev/trigger.dev@1347
pnpm add https://pkg.pr.new/triggerdotdev/trigger.dev/@trigger.dev/core@1347
pnpm add https://pkg.pr.new/triggerdotdev/trigger.dev/@trigger.dev/sdk@1347

commit: 069e087

No Sign up for free to join this conversation on GitHub. Already have an account? No Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant