Skip to content

chore: Added details for running local setup#35968

Merged
sagar-qa007 merged 1 commit intoreleasefrom
chore/setupdocument
Sep 9, 2024
Merged

chore: Added details for running local setup#35968
sagar-qa007 merged 1 commit intoreleasefrom
chore/setupdocument

Conversation

@sagar-qa007
Copy link
Contributor

@sagar-qa007 sagar-qa007 commented Aug 29, 2024

Description

Added more details for running local setup.
Screenshot 2024-08-29 at 12 15 09 PM

Fixes #35852

Automation

/ok-to-test tags="@tag.Sanity"

🔍 Cypress test results

Tip

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


Mon, 09 Sep 2024 05:29:13 UTC

Communication

Should the DevRel and Marketing teams inform users about this change?

  • Yes
  • No

Summary by CodeRabbit

  • New Features
    • Enhanced the setup process for integration tests with interactive prompts, allowing users to choose options regarding local server setup and Docker container usage.
    • Improved user experience by providing clear choices and consequences, making the setup more configurable and informative.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Aug 29, 2024

Walkthrough

The recent changes enhance the Cypress setup process by introducing interactive prompts for users during integration tests. Users can now choose whether to proceed without a local server, an accessible development URL, or to pull the latest Docker container for the TestEventDriver. This update allows for greater configurability and control over the setup process, making it more adaptable to individual user needs.

Changes

Files Change Summary
contributions/ClientSetup.md Added interactive prompts for setup decisions regarding local server, development URL, and Docker.

Assessment against linked issues

Objective Addressed Explanation
Update latest Cypress setup guide to help internal and external contributors. (#35852)

🎉 In the realm of code, a change so bright,
Interactive prompts now guide our flight.
With choices to make, our setup's a breeze,
Configurable paths, tailored to please.
So let’s embrace this new way to play,
Testing with joy, come what may! 🌟


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.

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.

@github-actions github-actions bot added the skip-changelog Adding this label to a PR prevents it from being listed in the changelog label Aug 29, 2024
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

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 3526696 and b8938d1.

Files selected for processing (1)
  • contributions/ClientSetup.md (1 hunks)
Additional context used
LanguageTool
contributions/ClientSetup.md

[uncategorized] ~123-~123: Loose punctuation mark.
Context: ...e appsmith-ce:release image. - yes: Selecting "yes" will skip the local s...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~131-~131: Loose punctuation mark.
Context: ...:** Simply close the process. - yes: Continue on the process for next stag...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~138-~138: Loose punctuation mark.
Context: ...te TED setup in local machine. - yes: Download the TED image and run the im...

(UNLIKELY_OPENING_PUNCTUATION)

Additional comments not posted (3)
contributions/ClientSetup.md (3)

118-123: Improve readability of options section.

The prompt and options are clear, but the formatting of the options section can be improved for better readability.

**Options:**
- **`no`:** Selecting "no" will trigger the setup of a local server using Docker with the `appsmith-ce:release` image.
- **`yes`:** Selecting "yes" will skip the local server setup process.
Tools
LanguageTool

[uncategorized] ~123-~123: Loose punctuation mark.
Context: ...e appsmith-ce:release image. - yes: Selecting "yes" will skip the local s...

(UNLIKELY_OPENING_PUNCTUATION)


126-131: Improve readability of options section.

The prompt and options are clear, but the formatting of the options section can be improved for better readability.

**Options:**
- **`no`:** Simply close the process.
- **`yes`:** Continue on the process for next stage.
Tools
LanguageTool

[uncategorized] ~131-~131: Loose punctuation mark.
Context: ...:** Simply close the process. - yes: Continue on the process for next stag...

(UNLIKELY_OPENING_PUNCTUATION)


133-138: Improve readability of options section.

The prompt and options are clear, but the formatting of the options section can be improved for better readability.

**Options:**
- **`no`:** It will not create TED setup in local machine.
- **`yes`:** Download the TED image and run the image for test purposes.
Tools
LanguageTool

[uncategorized] ~138-~138: Loose punctuation mark.
Context: ...te TED setup in local machine. - yes: Download the TED image and run the im...

(UNLIKELY_OPENING_PUNCTUATION)

@github-actions
Copy link

github-actions bot commented Sep 6, 2024

This PR has not seen activitiy for a while. It will be closed in 7 days unless further activity is detected.

@github-actions github-actions bot added the Stale label Sep 6, 2024
@sagar-qa007 sagar-qa007 added the ok-to-test Required label for CI label Sep 9, 2024
@sagar-qa007 sagar-qa007 merged commit 0e601a6 into release Sep 9, 2024
@sagar-qa007 sagar-qa007 deleted the chore/setupdocument branch September 9, 2024 05:31
Shivam-z pushed a commit to Shivam-z/appsmith that referenced this pull request Sep 26, 2024
## Description
Added more details for running local setup.
<img width="730" alt="Screenshot 2024-08-29 at 12 15 09 PM"
src="https://github.com/user-attachments/assets/45c63a3a-119a-4d8d-9be3-0dd9232023d7">



Fixes #`35852`  

## Automation

/ok-to-test tags="@tag.Sanity"

### 🔍 Cypress test results
<!-- This is an auto-generated comment: Cypress test results  -->
> [!TIP]
> 🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
> Workflow run:
<https://github.com/appsmithorg/appsmith/actions/runs/10766942068>
> Commit: b8938d1
> <a
href="https://internal.appsmith.com/app/cypress-dashboard/rundetails-65890b3c81d7400d08fa9ee5?branch=master&workflowId=10766942068&attempt=1"
target="_blank">Cypress dashboard</a>.
> Tags: `@tag.Sanity`
> Spec:
> <hr>Mon, 09 Sep 2024 05:29:13 UTC
<!-- end of auto-generated comment: Cypress test results  -->


## Communication
Should the DevRel and Marketing teams inform users about this change?
- [ ] Yes
- [x] No


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

- **New Features**
- Enhanced the setup process for integration tests with interactive
prompts, allowing users to choose options regarding local server setup
and Docker container usage.
- Improved user experience by providing clear choices and consequences,
making the setup more configurable and informative.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ok-to-test Required label for CI skip-changelog Adding this label to a PR prevents it from being listed in the changelog Stale

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants