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

fix: ignored target directory for spotless JSON formatting #35407

Merged
merged 1 commit into from
Aug 5, 2024

Conversation

NilanshBansal
Copy link
Contributor

@NilanshBansal NilanshBansal commented Aug 5, 2024

Description

This PR ignores the JSON files present in the target directory as it stores the temporary files that are generated during the build.
Fixes #35408

Automation

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

🔍 Cypress test results

Warning

Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/10245947583
Commit: 405ab04
Cypress dashboard.
Tags: @tag.Sanity
Spec:
It seems like no tests ran 😔. We are not able to recognize it, please check workflow here.


Mon, 05 Aug 2024 09:20:07 UTC

Communication

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

  • Yes
  • No

Summary by CodeRabbit

  • New Features
    • Introduced enhanced control over JSON file processing by excluding JSON files located in the target directory from the build process.

Copy link
Contributor

coderabbitai bot commented Aug 5, 2024

Important

Review skipped

Auto reviews are limited to specific labels.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The recent changes to the Maven project's pom.xml file introduce a new <excludes> configuration within the JSON processing section. This enhancement allows the build system to ignore JSON files located in the target directory, refining the scope of JSON file management during the build process. By excluding these files, the adjustment improves control over what is processed, thus streamlining the build operations.

Changes

Files Change Summary
app/server/pom.xml Added <excludes> block to the <json> section, excluding JSON files in the target directory.

Poem

In the realm of code where builders tread,
Exclusions sprout, where files once spread.
Target directories, now set aside,
JSON processing, with control and pride.
A cleaner build, a smoother flow,
Cheers to the changes, let progress grow! 🎉


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

@github-actions github-actions bot added the Bug Something isn't working label Aug 5, 2024
@NilanshBansal NilanshBansal changed the title fix: ignored target directory fix: ignored target directory for spotless JSON formatting Aug 5, 2024
@NilanshBansal NilanshBansal requested review from nidhi-nair and abhvsn and removed request for sharat87 August 5, 2024 08:56
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 6d47068 and 405ab04.

Files selected for processing (1)
  • app/server/pom.xml (1 hunks)
Additional comments not posted (1)
app/server/pom.xml (1)

162-164: Great job! The exclusion pattern looks correct.

The addition of the <excludes> block to exclude JSON files in the target directory will help streamline the build process by ignoring unnecessary files. This is a good practice to ensure that only relevant files are processed.

@NilanshBansal NilanshBansal self-assigned this Aug 5, 2024
@github-actions github-actions bot added Integrations Product Issues related to a specific integration Integrations Pod General Issues related to the Integrations Pod that don't fit into other tags. labels Aug 5, 2024
@NilanshBansal NilanshBansal added the ok-to-test Required label for CI label Aug 5, 2024
@github-actions github-actions bot added the Query & JS Pod Issues related to the query & JS Pod label Aug 5, 2024
@abhvsn abhvsn merged commit c888543 into release Aug 5, 2024
31 checks passed
@abhvsn abhvsn deleted the fix/spotless-ignore-target-directory branch August 5, 2024 09:16
abhvsn pushed a commit that referenced this pull request Aug 6, 2024
…35442)

Reverts #35407
Reverting as formatter is changing the sorting order of JSON keys, will
add back with the config for maintaining order.
Ref:
https://theappsmith.slack.com/archives/CGBPVEJ5C/p1722929754593669?thread_ts=1722916121.682699&cid=CGBPVEJ5C

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

## Summary by CodeRabbit

- **Bug Fixes**
- Removed exclusion of JSON files from the build process, allowing all
JSON files to be included, which may improve file accessibility but
could lead to unwanted files in the output.


<!-- 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
Bug Something isn't working Integrations Pod General Issues related to the Integrations Pod that don't fit into other tags. Integrations Product Issues related to a specific integration ok-to-test Required label for CI Query & JS Pod Issues related to the query & JS Pod
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: Post Adding Spotless JSON formatter the Server Target Files are showing errors
2 participants