Update Infisical instructions to new SDK by fgcoelho · Pull Request #1493 · triggerdotdev/trigger.dev

fgcoelho · 2024-11-22T21:46:44Z

Current documentation is using old Infisical SDK implementation.

New SDK has a different name, and authenticates on a method, not in the class constructor.

Summary by CodeRabbit

Documentation
- Enhanced clarity and detail in the "Environment Variables" document for Node.js applications.
- Expanded instructions for setting and editing environment variables, including visual aids.
- Updated example code for the syncEnvVars build extension and modified authentication method to reflect changes.
- Added guidance on syncing environment variables from Vercel and detailed instructions for using Google credential JSON files.

Current documentation is using old Infisical SDK implementation. New SDK has a different name, and authenticates on a method, not in the class constructor.

changeset-bot · 2024-11-22T21:46:47Z

⚠️ No Changeset found

Latest commit: 993b5e7

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

coderabbitai · 2024-11-22T21:46:56Z

Walkthrough

The changes in this pull request primarily focus on enhancing the documentation for managing environment variables in Node.js applications. Key updates include improved clarity in instructions, expanded sections on setting and editing environment variables, and detailed descriptions of SDK functions. Additionally, code examples have been updated to reflect changes in the InfisicalClient instantiation and authentication methods. New sections have been added to assist users with syncing environment variables from Vercel and using Google credential JSON files.

Changes

File	Change Summary
docs/deploy-environment-variables.mdx	Updated introduction emphasizing the importance of environment variables; expanded setting instructions with visual aids; clarified editing instructions; detailed SDK functions with a new table; updated example code for `syncEnvVars` and authentication method; added sections for syncing from Vercel and using Google credential JSON files.
trigger.config.ts	Method signature updated from `InfisicalClient` to `InfisicalSDK`.

Possibly related PRs

Docs - sync vercel env vars #1426: The changes in this PR involve updating documentation related to syncing environment variables from Vercel, which directly complements the main PR's focus on enhancing clarity and detail regarding the management of environment variables in Node.js applications.

Poem

🐇 In the land of code where variables play,
Clarity blooms in a bright, new way.
With SDKs and guides, we hop and we cheer,
For managing env vars has never been clear!
So let’s sync and deploy, with joy in our hearts,
In the world of Node, where each change imparts! 🌟

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.

coderabbitai

Actionable comments posted: 2

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 4305a23 and 50e89cb.

📒 Files selected for processing (1)

docs/deploy-environment-variables.mdx (1 hunks)

docs/deploy-environment-variables.mdx

matt-aitken

Thanks @Fgc17 :)

Update Infisical instructions to new SDK

50e89cb

Current documentation is using old Infisical SDK implementation. New SDK has a different name, and authenticates on a method, not in the class constructor.

coderabbitai bot reviewed Nov 22, 2024

View reviewed changes

docs/deploy-environment-variables.mdx Outdated Show resolved Hide resolved

docs/deploy-environment-variables.mdx Show resolved Hide resolved

fgcoelho added 2 commits November 22, 2024 19:17

Fix import and client secret env

993b5e7

Merge branch 'main' into main

ade1dab

matt-aitken approved these changes Nov 28, 2024

View reviewed changes

matt-aitken merged commit 736f577 into triggerdotdev:main Nov 28, 2024

coderabbitai bot mentioned this pull request Nov 28, 2024

Update deploy-environment-variables.mdx #1509

Merged

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Update Infisical instructions to new SDK#1493

Update Infisical instructions to new SDK#1493
matt-aitken merged 3 commits intotriggerdotdev:mainfrom
fgcoelho:main

fgcoelho commented Nov 22, 2024 •

edited by coderabbitai bot

Loading

Uh oh!

changeset-bot bot commented Nov 22, 2024 •

edited

Loading

Uh oh!

coderabbitai bot commented Nov 22, 2024 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Uh oh!

matt-aitken left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

fgcoelho commented Nov 22, 2024 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

changeset-bot bot commented Nov 22, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

⚠️ No Changeset found

Uh oh!

coderabbitai bot commented Nov 22, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Possibly related PRs

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

matt-aitken left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

fgcoelho commented Nov 22, 2024 •

edited by coderabbitai bot

Loading

changeset-bot bot commented Nov 22, 2024 •

edited

Loading

coderabbitai bot commented Nov 22, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)