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

ci: Fix for command without spec #38353

Merged
merged 1 commit into from
Dec 26, 2024
Merged

Conversation

sagar-qa007
Copy link
Contributor

@sagar-qa007 sagar-qa007 commented Dec 24, 2024

Description

Fix for command without spec.

Fixes # https://app.zenhub.com/workspaces/stability-pod-6690c4814e31602e25cab7fd/issues/gh/appsmithorg/appsmith/38352

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/12482462821
Commit: add048b
Cypress dashboard.
Tags: @tag.Sanity
Spec:


Tue, 24 Dec 2024 14:11:18 UTC

Communication

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

  • Yes
  • No

Summary by CodeRabbit

  • New Features

    • Enhanced flexibility in specifying test files with a new input parameter specs_to_run.
    • Default value for specs_to_run is now set to 'no_data' when not provided.
  • Bug Fixes

    • Improved error handling for cases where no specifications are provided, including fallback to a specified file.
  • Documentation

    • Updated comments for clarity in workflow processes.

Copy link
Contributor

coderabbitai bot commented Dec 24, 2024

Walkthrough

The pull request modifies two GitHub Actions workflow files to improve the handling of test specifications. In .github/workflows/build-client-server-count.yml, a change was made to set a default 'no_data' value when no specs are provided. The .github/workflows/ci-test-limited-with-count.yml workflow was enhanced with more robust logic for reading and processing test specifications, including fallback mechanisms and improved logging.

Changes

File Change Summary
.github/workflows/build-client-server-count.yml Updated specs_to_run output to default to 'no_data' instead of an empty string
.github/workflows/ci-test-limited-with-count.yml Added specs_to_run input parameter, improved spec retrieval logic with fallback to limited-tests.txt and enhanced debug logging

Possibly related PRs

Suggested Labels

bug, ok-to-test, CI

Suggested Reviewers

  • sharat87
  • ApekshaBhosale

Poem

🤖 Workflows dance with specs so bright,
No data? Fear not, we'll set it right!
From empty strings to 'no_data' clear,
CI pipelines now have no fear!
Specs will run, or gracefully rest 🚀


🪧 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. (Beta)
  • @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.

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 Bug Something isn't working label Dec 24, 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

🧹 Nitpick comments (2)
.github/workflows/build-client-server-count.yml (1)

51-58: LGTM with minor formatting fix.

The implementation for handling the specs_to_run argument is clean and consistent with other argument handling in the file.

Remove the trailing space on line 51.

🧰 Tools
🪛 yamllint (1.35.1)

[error] 51-51: trailing spaces

(trailing-spaces)

.github/workflows/ci-test-limited-with-count.yml (1)

144-195: LGTM with suggested improvements.

The implementation provides robust error handling and clear logging for spec retrieval. Consider the following improvements:

  1. Quote variables to prevent word splitting:
-if [[ -z "$specs_to_run" || "$specs_to_run" == "no_data" ]]; then
+if [[ -z "${specs_to_run}" || "${specs_to_run}" == "no_data" ]]; then
  1. Remove trailing spaces on lines 151 and 195.

  2. Consider using an array to store specs instead of string concatenation:

-specs_to_run="$specs_to_run,$line"
+specs_array+=("$line")
+specs_to_run=$(IFS=,; echo "${specs_array[*]}")
🧰 Tools
🪛 actionlint (1.7.4)

146-146: shellcheck reported issue in this script: SC2086:info:48:38: Double quote to prevent globbing and word splitting

(shellcheck)

🪛 yamllint (1.35.1)

[error] 151-151: trailing spaces

(trailing-spaces)


[error] 195-195: trailing spaces

(trailing-spaces)

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c0d393a and add048b.

📒 Files selected for processing (2)
  • .github/workflows/build-client-server-count.yml (2 hunks)
  • .github/workflows/ci-test-limited-with-count.yml (3 hunks)
🧰 Additional context used
🪛 yamllint (1.35.1)
.github/workflows/build-client-server-count.yml

[error] 51-51: trailing spaces

(trailing-spaces)

.github/workflows/ci-test-limited-with-count.yml

[error] 151-151: trailing spaces

(trailing-spaces)


[error] 195-195: trailing spaces

(trailing-spaces)

🪛 actionlint (1.7.4)
.github/workflows/ci-test-limited-with-count.yml

146-146: shellcheck reported issue in this script: SC2086:info:48:38: Double quote to prevent globbing and word splitting

(shellcheck)

🔇 Additional comments (2)
.github/workflows/build-client-server-count.yml (1)

118-118: LGTM!

The PR comment body has been simplified to show only essential information.

.github/workflows/ci-test-limited-with-count.yml (1)

31-31: LGTM!

The specs_to_run parameter is consistently defined for both workflow triggers with appropriate defaults and descriptions.

Also applies to: 57-58

@sagar-qa007 sagar-qa007 added the ok-to-test Required label for CI label Dec 24, 2024
@sagar-qa007 sagar-qa007 changed the title fix: Fix for command without spec ci: Fix for command without spec Dec 24, 2024
@sagar-qa007 sagar-qa007 added CI and removed Bug Something isn't working labels Dec 24, 2024
@github-actions github-actions bot added the skip-changelog Adding this label to a PR prevents it from being listed in the changelog label Dec 24, 2024
Copy link
Collaborator

@NandanAnantharamu NandanAnantharamu left a comment

Choose a reason for hiding this comment

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

Lgtm

@sagar-qa007 sagar-qa007 merged commit bc2480d into release Dec 26, 2024
53 of 55 checks passed
@sagar-qa007 sagar-qa007 deleted the chore/commandupdatefix branch December 26, 2024 05:39
NandanAnantharamu pushed a commit that referenced this pull request Dec 27, 2024
## Description
Fix for command without spec.


Fixes #
https://app.zenhub.com/workspaces/stability-pod-6690c4814e31602e25cab7fd/issues/gh/appsmithorg/appsmith/38352

## 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/12482462821>
> Commit: add048b
> <a
href="https://internal.appsmith.com/app/cypress-dashboard/rundetails-65890b3c81d7400d08fa9ee5?branch=master&workflowId=12482462821&attempt=1"
target="_blank">Cypress dashboard</a>.
> Tags: `@tag.Sanity`
> Spec:
> <hr>Tue, 24 Dec 2024 14:11:18 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 flexibility in specifying test files with a new input
parameter `specs_to_run`.
- Default value for `specs_to_run` is now set to `'no_data'` when not
provided.
  
- **Bug Fixes**
- Improved error handling for cases where no specifications are
provided, including fallback to a specified file.

- **Documentation**
	- Updated comments for clarity in workflow processes.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
@coderabbitai coderabbitai bot mentioned this pull request Dec 31, 2024
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI ok-to-test Required label for CI skip-changelog Adding this label to a PR prevents it from being listed in the changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants