search

appsmithorg / appsmith

Platform to build admin panels, internal tools, and dashboards. Integrates with 25+ databases and any API.
https://www.appsmith.com
Apache License 2.0
31.96k stars 3.44k forks source link

ci: Move check for new JS Cypress tests to GitHub script #33560

Closed sharat87 closed 1 week ago

sharat87 commented 2 weeks ago

We have a check when running Cypress tests to ensure that no new .js files are added under Cypress folder. This PR moves this check to a separate JS file. There's another check that does some ADS compliance, which I'll port in a follow-up PR.

Why am I hitting on this? One, to move away from umani/changed-files workflow, which has randomly failed for us in the past, and id doesn't do so much special for us anyway. Two, this workflow is the last usage of APPSMITH_CI_TEST_PAT secret, so I should be able to remove that secret as well. One less secret.

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

coderabbitai[bot] commented 1 week ago
Walkthrough ## Walkthrough The recent updates focus on refining GitHub workflows for the client build and Cypress tests. Key modifications include removing the `check-test-files` input, updating permissions, and enhancing the script for test file format checks. Additionally, a new script, `client-build-compliance.js`, was introduced to ensure new JavaScript test files are ported to TypeScript and to manage Cypress test triggers effectively. ## Changes | File Path | Change Summary | |---------------------------------------------|------------------------------------------------------------------------------------------------------| | `.github/workflows/client-build.yml` | Removed `check-test-files` input, adjusted permissions, updated `working-directory` and `shell` settings, and switched to `actions/github-script@v7` for test file format checks. | | `.github/workflows/pr-cypress.yml` | Removed `check-test-files: "true"` configuration under the `cypress-run` job. | | `.github/workflows/scripts/client-build-compliance.js` | Introduced a new script to check for new JavaScript test files, prompt for TypeScript porting, and trigger Cypress tests. |
Recent Review Details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between 16cd15a103b63ae2e32448245e026fe7ef786f1d and 398f7df5b67ea9aa996a293aeff6cf8a69688d3c.
Files selected for processing (3) * .github/workflows/client-build.yml (4 hunks) * .github/workflows/pr-cypress.yml (1 hunks) * .github/workflows/scripts/client-build-compliance.js (1 hunks)
Files skipped from review due to trivial changes (2) * .github/workflows/client-build.yml * .github/workflows/pr-cypress.yml
Additional comments not posted (1)
.github/workflows/scripts/client-build-compliance.js (1)
`1-1`: Ensure proper error handling for the async function. Consider wrapping the function's body in a try-catch block to handle potential exceptions from API calls or other operations.
--- 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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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.` 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 a review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.