chore: Fix quoting in `deploy_preview.sh` by sharat87 · Pull Request #34592 · appsmithorg/appsmith

sharat87 · 2024-06-28T16:11:41Z

/test sanity

Tip

🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/9716093497
Commit: f2381c9
Cypress dashboard.
Tags: @tag.Sanity

Summary by CodeRabbit

Chores
- Updated deployment script to improve environment variable handling and AWS configuration for preview environments.

coderabbitai · 2024-06-28T16:11:47Z

Walkthrough

The deploy_preview.sh script has been updated to streamline and parameterize various environment variables, including AWS configurations, Kubernetes operations, and Docker registry secrets. The introduction of the edition variable allows for more flexible deployments. Changes also include AWS STS role assumption and dynamic naming for namespaces, charts, secrets, and domain names.

Changes

File	Change Summary
`scripts/deploy_preview.sh`	Introduced `edition` variable, updated environment variables for AWS configurations, Kubernetes namespace, chart names, secrets, and domain names. Improved process for AWS STS role assumption, Docker registry secrets creation, and Helm chart deployments.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Script as deploy_preview.sh
    participant AWS
    participant Kubernetes
    participant Helm

    User->>Script: Run deploy_preview.sh
    Script->>AWS: Assume Role (sts assume-role)
    AWS-->>Script: Return Temporary Credentials
    Script->>Script: Set AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, AWS_SESSION_TOKEN
    Script->>Script: Set namespace, chartname, secret, dbname, domainname using edition and PR number
    Script->>Kubernetes: Configure Namespace
    Script->>Kubernetes: Create Secrets
    Script->>Kubernetes: Manage EFS (Elastic File System)
    Script->>Helm: Deploy Helm Charts
    Helm-->>Script: Confirm Deployment
    Script-->>User: Deployment Complete

Poem

A script so fine, for deploy's sake,
With editions now, new paths to take.
AWS roles assumed, credentials in queue,
Namespaces, charts, secrets anew.
Helm deploys with steady hand,
In Kubernetes, our app will stand.
CodeRabbit smiles, the job is done,
A new horizon, just begun. 🌟🐇

Tip

Early access features

OpenAI gpt-4o model for reviews and chat.

Note:

You can disable early access features from the CodeRabbit UI or by setting early_access: false in the CodeRabbit configuration file.
Please join our Discord Community to provide feedback and report issues.
OSS projects are always opted into early access features.

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>.
- 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 generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

sharat87 · 2024-06-28T16:13:06Z

/build-deploy-preview skip-tests=true

github-actions · 2024-06-28T16:13:26Z

Deploying Your Preview: https://github.com/appsmithorg/appsmith/actions/runs/9715749877.
Workflow: On demand build Docker image and deploy preview.
skip-tests: true.
env: ``.
PR: 34592.
recreate: .

github-actions · 2024-06-28T16:18:36Z

Deploy-Preview-URL: https://ce-34592.dp.appsmith.com

sharat87 · 2024-06-29T00:58:49Z

/build-deploy-preview skip-tests=true

github-actions · 2024-06-29T00:59:14Z

Deploying Your Preview: https://github.com/appsmithorg/appsmith/actions/runs/9720295812.
Workflow: On demand build Docker image and deploy preview.
skip-tests: true.
env: ``.
PR: 34592.
recreate: .

github-actions · 2024-06-29T01:05:11Z

Deploy-Preview-URL: https://ce-34592.dp.appsmith.com

coderabbitai

Actionable comments posted: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between e662e7e and f2381c9.

Files selected for processing (1)

scripts/deploy_preview.sh (3 hunks)

Additional context used

Shellcheck

scripts/deploy_preview.sh

[warning] 32-32: Declare and assign separately to avoid masking return values.

(SC2155)

[warning] 33-33: Declare and assign separately to avoid masking return values.

(SC2155)

[warning] 34-34: Declare and assign separately to avoid masking return values.

(SC2155)

Additional comments not posted (10)

scripts/deploy_preview.sh (10)

4-4: LGTM!

The introduction of the edition variable is a good addition for flexibility.

10-11: LGTM!

AWS credentials are being configured correctly.

36-40: LGTM!

Using the edition variable to set environment variables is a good approach for consistency.

46-46: LGTM!

Updating the kubeconfig for AWS EKS is done correctly.

57-62: LGTM!

The commands for recreating resources are correctly structured.

65-65: LGTM!

Placeholder comments for future improvements are noted.

76-76: LGTM!

Creating the namespace using the NAMESPACE variable is done correctly.

78-81: LGTM!

Creating the Docker registry secret is done correctly.

84-88: LGTM!

Adding the Helm repository and installing the plugin is done correctly.

91-108: LGTM!

Deploying the Appsmith Helm chart with the specified configurations is done correctly.

scripts/deploy_preview.sh

**/test sanity**  > [!TIP] > 🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉 > Workflow run: <https://github.com/appsmithorg/appsmith/actions/runs/9716093497> > Commit: f2381c9 > <a href="https://internal.appsmith.com/app/cypress-dashboard/rundetails-65890b3c81d7400d08fa9ee5?branch=master&workflowId=9716093497&attempt=1" target="_blank">Cypress dashboard</a>. > Tags: `@tag.Sanity`   ## Summary by CodeRabbit - **Chores** - Updated deployment script to improve environment variable handling and AWS configuration for preview environments.

sharat87 added 5 commits June 28, 2024 18:43

chore: Fix datasource creation throwing 400

699f005

refactor

95ec86a

again

4239ee6

Fix database datasource creation

85495fb

chore: Fix some quoting in deploy_preview.sh

b3cd377

Discard changes to app/client/src/api/DatasourcesApi.ts

4a0f960

sharat87 changed the title ~~chore/dp script 1~~ chore: Fix some quoting in deploy_preview.sh Jun 28, 2024

github-actions bot added the skip-changelog Adding this label to a PR prevents it from being listed in the changelog label Jun 28, 2024

More variables quoted

f2381c9

sharat87 added the ok-to-test Required label for CI label Jun 28, 2024

sharat87 marked this pull request as ready for review June 29, 2024 01:35

sharat87 requested review from mohanarpit, pratapaprasanna and zbuildz June 29, 2024 01:35

coderabbitai bot reviewed Jun 29, 2024

View reviewed changes

scripts/deploy_preview.sh Show resolved Hide resolved

sharat87 changed the title ~~chore: Fix some quoting in deploy_preview.sh~~ chore: Fi quoting in deploy_preview.sh Jun 29, 2024

sharat87 changed the title ~~chore: Fi quoting in deploy_preview.sh~~ chore: Fix quoting in deploy_preview.sh Jun 29, 2024

pratapaprasanna approved these changes Jul 1, 2024

View reviewed changes

pratapaprasanna merged commit ff44b4f into release Jul 1, 2024

pratapaprasanna deleted the chore/dp-script-1 branch July 1, 2024 09:36

coderabbitai bot mentioned this pull request Nov 7, 2024

chore: Fix condition syntax in Dockerfile #37270

Merged

2 tasks

coderabbitai bot mentioned this pull request Nov 29, 2024

ci: Only allow appsmith.com emails to signup on DPs #37858

Closed

2 tasks

This was referenced Jan 30, 2025

Chore/add/ai/env/dps #38926

Closed

chore: add AI related env variables to dps #38927

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: Fix quoting in `deploy_preview.sh`#34592

chore: Fix quoting in `deploy_preview.sh`#34592
pratapaprasanna merged 7 commits intoreleasefrom
chore/dp-script-1

sharat87 commented Jun 28, 2024 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Jun 28, 2024 •

edited

Loading

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

sharat87 commented Jun 28, 2024

Uh oh!

github-actions bot commented Jun 28, 2024

Uh oh!

github-actions bot commented Jun 28, 2024

Uh oh!

sharat87 commented Jun 29, 2024

Uh oh!

github-actions bot commented Jun 29, 2024

Uh oh!

github-actions bot commented Jun 29, 2024

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

sharat87 commented Jun 28, 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!

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

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Poem

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

sharat87 commented Jun 28, 2024

Uh oh!

github-actions bot commented Jun 28, 2024

Uh oh!

github-actions bot commented Jun 28, 2024

Uh oh!

sharat87 commented Jun 29, 2024

Uh oh!

github-actions bot commented Jun 29, 2024

Uh oh!

github-actions bot commented Jun 29, 2024

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

sharat87 commented Jun 28, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jun 28, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)