Skip to content

chore: adds depandabot.yml#40521

Merged
rahulbarwal merged 3 commits intoreleasefrom
rahulbarwal/Remove-tinyMCE-precommit-check-and-move-to-dependabot-configuration-
May 1, 2025
Merged

chore: adds depandabot.yml#40521
rahulbarwal merged 3 commits intoreleasefrom
rahulbarwal/Remove-tinyMCE-precommit-check-and-move-to-dependabot-configuration-

Conversation

@rahulbarwal
Copy link
Contributor

@rahulbarwal rahulbarwal commented May 1, 2025

Description

We are implementing this to control Dependabot alerts and prevent flagging of the TinyMCE library, which we are maintaining at version 6.8.3.

  • Additionally, we have reverted the change that checks for TinyMCE version updates in the pre-commit hook. Managing this within the Dependabot configuration file is a better approach.

Fixes #Issue Number
or
Fixes Issue URL

Warning

If no issue exists, please create an issue first, and check with the maintainers if the issue is valid.

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


Thu, 01 May 2025 05:43:58 UTC

Communication

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

  • Yes
  • No

Summary by CodeRabbit

  • Chores
    • Added automated dependency update configuration to streamline npm package management, with specific rules for update frequency, labeling, and commit message formatting.
  • Refactor
    • Simplified pre-commit checks by removing restrictions related to TinyMCE version changes.

@rahulbarwal rahulbarwal requested a review from riodeuno as a code owner May 1, 2025 04:09
@rahulbarwal rahulbarwal self-assigned this May 1, 2025
@rahulbarwal rahulbarwal added Dependencies Pull requests that update a dependency file github_actions Pull requests that update GitHub Actions code labels May 1, 2025
@rahulbarwal rahulbarwal requested review from hetunandu and jsartisan and removed request for riodeuno May 1, 2025 04:09
@rahulbarwal rahulbarwal enabled auto-merge (squash) May 1, 2025 04:09
@coderabbitai
Copy link
Contributor

coderabbitai bot commented May 1, 2025

Walkthrough

A new Dependabot configuration file has been added to automate npm and Maven dependency updates in the /app/client and /app/server directories, respectively, with defined schedules, labeling, and commit message formatting. The configuration includes an explicit ignore rule for the tinymce package at version 6.8.3. Additionally, a Husky pre-commit hook script was modified to remove the check_tinymce_version function and its invocation, thereby allowing changes to the TinyMCE version in package.json. Minor whitespace adjustments were also made in the script.

Changes

File(s) Change Summary
.github/dependabot.yml Added Dependabot config for npm and Maven dependencies with schedules, labels, commit message formatting, and ignoring tinymce@6.8.3.
app/client/.husky/check-staged-files.sh Removed check_tinymce_version function and its invocation, allowing TinyMCE version changes in package.json. Minor whitespace tweaks.

Possibly related PRs

Suggested labels

Task

Suggested reviewers

  • riodeuno
  • vivek-appsmith

Poem

Dependabot knocks on the weekly door,
Updating dependencies, never a bore.
TinyMCE’s version, now free to roam,
No more checks to keep it home.
Scripts are lighter, configs anew—
Automated updates, coming through! 🚀


📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro (Legacy)

📥 Commits

Reviewing files that changed from the base of the PR and between 11aa0fe and bc96027.

📒 Files selected for processing (1)
  • .github/dependabot.yml (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • .github/dependabot.yml
⏰ Context from checks skipped due to timeout of 90000ms (7)
  • GitHub Check: perform-test / client-build / client-build
  • GitHub Check: perform-test / server-build / server-unit-tests
  • GitHub Check: perform-test / rts-build / build
  • GitHub Check: client-unit-tests / client-unit-tests
  • GitHub Check: client-build / client-build
  • GitHub Check: client-lint / client-lint
  • GitHub Check: client-prettier / prettier-check

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

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 sequence diagram to generate a sequence diagram of the changes in this 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.

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.

@rahulbarwal rahulbarwal added the ok-to-test Required label for CI label May 1, 2025
@github-actions github-actions bot added the skip-changelog Adding this label to a PR prevents it from being listed in the changelog label May 1, 2025
jsartisan
jsartisan previously approved these changes May 1, 2025
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 (4)
.github/dependabot.yml (1)

5-9: Ensure ignore rule covers intended TinyMCE versions.
You’ve set Dependabot to ignore updates for tinymce at version 6.8.3. If the goal is to ignore all patch updates within 6.8 (e.g., 6.8.4, 6.8.5), consider using a wildcard range like "6.8.x" instead of a fixed version.

app/client/.husky/check-staged-files.sh (3)

10-10: Consider handling filenames with spaces.
Using grep and sed on git diff --name-only output can break if filenames contain whitespace. To robustly handle all cases, you could switch to NUL-delimited output:

- staged_server_files=$(git diff --cached --name-only | grep "app/server" | sed 's|app/server/||')
+ staged_server_files=$(git diff --cached --name-only -z \
+   | grep -z "app/server" \
+   | sed -z 's|app/server/||' \
+   | xargs -0)

12-12: Normalize indentation for consistency.
The leading spaces before this comment are deeper than surrounding lines. Align to the script’s two-space indent convention:

-   # Check if Spotless succeeded
+  # Check if Spotless succeeded

26-28: Add error handling to pushd/popd.
Shellcheck (SC2164) warns that pushd/popd may fail silently. Guard against failures to avoid surprising behavior:

-    pushd app/server > /dev/null
+    pushd app/server > /dev/null || exit 1

     apply_spotless_and_commit_staged_files

-    popd > /dev/null
+    popd > /dev/null || exit 1
🧰 Tools
🪛 Shellcheck (0.10.0)

[warning] 26-26: Use 'pushd ... || exit' or 'pushd ... || return' in case pushd fails.

(SC2164)


[warning] 28-28: Use 'popd ... || exit' or 'popd ... || return' in case popd fails.

(SC2164)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between bb5a202 and 11aa0fe.

📒 Files selected for processing (2)
  • .github/dependabot.yml (1 hunks)
  • app/client/.husky/check-staged-files.sh (2 hunks)
🧰 Additional context used
🪛 Shellcheck (0.10.0)
app/client/.husky/check-staged-files.sh

[warning] 26-26: Use 'pushd ... || exit' or 'pushd ... || return' in case pushd fails.

(SC2164)


[warning] 28-28: Use 'popd ... || exit' or 'popd ... || return' in case popd fails.

(SC2164)

⏰ Context from checks skipped due to timeout of 90000ms (6)
  • GitHub Check: perform-test / client-build / client-build
  • GitHub Check: perform-test / server-build / server-unit-tests
  • GitHub Check: client-unit-tests / client-unit-tests
  • GitHub Check: client-lint / client-lint
  • GitHub Check: client-build / client-build
  • GitHub Check: client-prettier / prettier-check
🔇 Additional comments (2)
.github/dependabot.yml (2)

1-4: Validate the package-ecosystem and path.
Using package-ecosystem: "npm" and directory: "/app/client" correctly scopes Dependabot to your frontend dependencies. Confirm that all relevant client-side packages live under this path and that no additional ecosystems (e.g., GitHub Actions, Docker) require their own entries.


10-16: Review PR limits, labels, and commit formatting.
Limiting to 5 open PRs, tagging with dependencies/javascript, and using a chore(scope): commit message prefix all align with common conventions. Ensure these labels exist in your repo and that any bots or CI workflows correctly interpret the chore prefix.

Copy link
Member

@hetunandu hetunandu left a comment

Choose a reason for hiding this comment

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

dependabot is also used to check server dependencies. this change will force it to be client only

@rahulbarwal rahulbarwal merged commit fb7c3d1 into release May 1, 2025
46 checks passed
@rahulbarwal rahulbarwal deleted the rahulbarwal/Remove-tinyMCE-precommit-check-and-move-to-dependabot-configuration- branch May 1, 2025 05:44
@ApekshaBhosale ApekshaBhosale mentioned this pull request Jul 30, 2025
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Dependencies Pull requests that update a dependency file github_actions Pull requests that update GitHub Actions code 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.

3 participants