Skip to content
New issue

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

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

Adds more org names to the alert emails #1561

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

samejr
Copy link
Member

@samejr samejr commented Dec 13, 2024

Adding more org name info to the alert emails.

  • Added org name to the subject line
  • Added org name to the body of the deploy success and fail emails

Summary by CodeRabbit

  • New Features

    • Enhanced email notifications for deployment successes and failures by including the organization name in the message body.
    • Updated subject lines for email templates to include the organization name for better context.
  • Bug Fixes

    • Improved clarity in email messages related to deployment outcomes.

Copy link

changeset-bot bot commented Dec 13, 2024

⚠️ No Changeset found

Latest commit: ef7e976

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 Dec 13, 2024

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 eslint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

internal-packages/emails/emails/deployment-failure.tsx

Oops! Something went wrong! :(

ESLint: 8.45.0

ESLint couldn't find the config "custom" to extend from. Please check that the name of the config is correct.

The config "custom" was referenced from the config file in "/.eslintrc.js".

If you still have problems, please stop by https://eslint.org/chat/help to chat with the team.

Walkthrough

The changes introduced in this pull request involve modifications to the text displayed in email notifications related to deployment events. Specifically, the messages in the deployment-failure.tsx and deployment-success.tsx files now include the organization name for clearer context. Additionally, the subject lines of several email templates in the EmailClient class have been updated to incorporate the organization name. No alterations were made to the logic or structure of exported entities.

Changes

File Path Change Summary
internal-packages/emails/emails/deployment-failure.tsx Updated text in Email function to include organization name in deployment failure message.
internal-packages/emails/emails/deployment-success.tsx Updated text in Email function to include organization name in deployment success message.
internal-packages/emails/src/index.tsx Modified subject lines in EmailClient to include organization name for various alert emails.

Possibly related PRs

  • Alert emails now contain the Org name #1555: This PR adds the organization name to various alert emails, including deployment failure and success notifications, which directly relates to the changes made in the main PR that also modifies the deployment failure and success messages to include the organization context.

🐰 In the meadow, where emails fly,
A message now clearer, oh my, oh my!
With organizations named, in success and in plight,
Our notifications shine ever so bright!
Hopping along, we spread the good cheer,
For every deployment, we hold dear! 🌟


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 generate docstrings to generate docstrings for this PR. (Experiment)
  • @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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (2)
internal-packages/emails/emails/deployment-success.tsx (1)

42-42: Consider improving text readability

While the organization context addition is good, the sentence structure could be more concise.

Consider this alternative text structure:

->{`Version ${version} successfully deployed ${taskCount} tasks in ${environment} in your ${organization} organization`}
+>{`Version ${version} successfully deployed ${taskCount} tasks to ${environment} for ${organization}`}
internal-packages/emails/emails/deployment-failure.tsx (1)

57-59: Consider improving error message clarity

While the organization context addition is good, the sentence structure could be more concise.

Consider this alternative text structure:

->{`An error occurred deploying ${version} in ${environment} in your ${organization} organization`}
+>{`Deployment failed for ${version} to ${environment} (${organization})`}
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f0182ab and 0f16fb4.

📒 Files selected for processing (3)
  • internal-packages/emails/emails/deployment-failure.tsx (1 hunks)
  • internal-packages/emails/emails/deployment-success.tsx (1 hunks)
  • internal-packages/emails/src/index.tsx (1 hunks)
🔇 Additional comments (1)
internal-packages/emails/src/index.tsx (1)

103-103: LGTM! Consistent organization prefix format across alert types

The organization name has been consistently added as a prefix in square brackets across all alert types, providing clear organizational context in email subjects.

Also applies to: 109-109, 115-115, 121-121

Copy link

pkg-pr-new bot commented Dec 13, 2024

@trigger.dev/build

npm i https://pkg.pr.new/triggerdotdev/trigger.dev/@trigger.dev/build@1561

@trigger.dev/core

npm i https://pkg.pr.new/triggerdotdev/trigger.dev/@trigger.dev/core@1561

@trigger.dev/react-hooks

npm i https://pkg.pr.new/triggerdotdev/trigger.dev/@trigger.dev/react-hooks@1561

trigger.dev

npm i https://pkg.pr.new/triggerdotdev/trigger.dev@1561

@trigger.dev/rsc

npm i https://pkg.pr.new/triggerdotdev/trigger.dev/@trigger.dev/rsc@1561

@trigger.dev/sdk

npm i https://pkg.pr.new/triggerdotdev/trigger.dev/@trigger.dev/sdk@1561

commit: ef7e976

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

Successfully merging this pull request may close these issues.

1 participant