NoMongo: Restore the GraphQL Introspection GitHub Action Test #3485

[Priyanshuthapliyal2005]

What kind of change does this PR introduce?
NoMongo: Restore the GraphQL Introspection GitHub Action Test

Issue Number:

Fixes #3485

Snapshots/Videos:

If relevant, did you update the documentation?

Summary

Does this PR introduce a breaking change?

Checklist

CodeRabbit AI Review

• I have reviewed and addressed all critical issues flagged by CodeRabbit AI
• I have implemented or provided justification for each non-critical suggestion
• I have documented my reasoning in the PR comments where CodeRabbit AI suggestions were not implemented

Test Coverage

• I have written tests for all new changes/features
• I have verified that test coverage meets or exceeds 95%
• I have run the test suite locally and all tests pass

Other information

Have you read the contributing guide?

Summary by CodeRabbit

• Workflow Updates

  • Refined GitHub Actions workflow configuration
  • Updated workflow triggers to target specific branch
  • Modified Node.js version from 22.x to 20.x
  • Added GraphQL schema validation job
  • Updated documentation deployment process

• Dependencies

  • Added GraphQL inspector CLI as a development dependency

[coderabbitai]

Walkthrough

This pull request focuses on updating the GitHub Actions workflow configuration in .github/workflows/pull-request.yml. The changes include modifying workflow triggers to target the develop-postgres branch, updating Node.js version, reformatting job descriptions, and introducing new jobs for GraphQL schema validation. A new GraphQL inspector CLI dependency was added to package.json. The workflow has been streamlined by removing some Python compliance checks and improving overall readability and execution clarity.

Changes

File	Change Summary
.github/workflows/pull-request.yml	- Updated workflow to trigger only on develop-postgres branch - Modified Node.js version from 22.x to 20.x - Increased line count threshold from 600 to 1100 - Added GraphQL schema validation jobs - Updated script execution and conditional logic - Removed Python compliance checks
package.json	- Added "@graphql-inspector/cli": "^5.0.0" to devDependencies

Assessment against linked issues

Objective	Addressed	Explanation
Restore GraphQL Introspection GitHub Action Test [#3485]	✅
Validate GraphQL documents	✅
Update workflow for develop-postgres branch	✅

Possibly related issues

• NoMongo: Restore the GraphQL Introspection GitHub Action Test #3235: Directly related to restoring GraphQL introspection tests
• Fix the introspection GitHub action tests (Oct 2024) #2385: Addresses similar GraphQL introspection test failures
• NoMongo: Fix the CodeCov GitHub Action in the develop-postgres branch #3269: Relates to GitHub Action and code coverage modifications

Possibly related PRs

• fix: pull-request.yml to ignore actions on ignore-sensitive-files-pr and Introspection workflow #2391: Modifies .github/workflows/pull-request.yml
• added docker check to workflow #2414: Updates workflow configuration
• [NoMongo] Fix : CodeCov GitHub Action #3271: Enhances testing and coverage reporting

Suggested labels

ignore-sensitive-files-pr

Suggested reviewers

• palisadoes
• varshith257
• noman2002

Poem

🐰 In GitHub's garden of code so bright,
Workflows dance with renewed might
GraphQL schemas now shine clear
Postgres branch triggers without fear
A rabbit's workflow, sleek and lean! 🚀

---

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
• Mastodon
• Reddit
• LinkedIn

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

Our Pull Request Approval Process

Thanks for contributing!

Testing Your Code

Remember, your PRs won't be reviewed until these criteria are met:

1. We don't merge PRs with poor code quality.
   1. Follow coding best practices such that CodeRabbit.ai approves your PR.
2. We don't merge PRs with failed tests.
   1. When tests fail, click on the Details link to learn more.
   2. Write sufficient tests for your changes (CodeCov Patch Test). Your testing level must be better than the target threshold of the repository
   3. Tests may fail if you edit sensitive files. Ask to add the ignore-sensitive-files-pr label if the edits are necessary.
3. We cannot merge PRs with conflicting files. These must be fixed.

Our policies make our code better.

Reviewers

Do not assign reviewers. Our Queue Monitors will review your PR and assign them.
When your PR has been assigned reviewers contact them to get your code reviewed and approved via:

1. comments in this PR or
2. our slack channel

Reviewing Your Code

Your reviewer(s) will have the following roles:

1. arbitrators of future discussions with other contributors about the validity of your changes
2. point of contact for evaluating the validity of your work
3. person who verifies matching issues by others that should be closed.
4. person who gives general guidance in fixing your tests

CONTRIBUTING.md

Read our CONTRIBUTING.md file. Most importantly:

1. PRs with issues not assigned to you will be closed by the reviewer
2. Fix the first comment in the PR so that each issue listed automatically closes

Other

1. 🎯 Please be considerate of our volunteers' time. Contacting the person who assigned the reviewers is not advised unless they ask for your input. Do not @ the person who did the assignment otherwise.
2. Read the CONTRIBUTING.md file make

[coderabbitai]

Actionable comments posted: 3

🧹 Nitpick comments (1)

.github/workflows/pull-request.yml (1)

148-148: Fix YAML formatting issues.

Address the following formatting issues flagged by YAMLlint:

• Remove trailing spaces on lines 148, 214, and 269
• Add a newline at the end of the file

Also applies to: 214-214, 269-269, 498-498

🧰 Tools

🪛 YAMLlint (1.35.1)

[error] 148-148: trailing spaces

(trailing-spaces)

🪛 GitHub Actions: PR Workflow

[error] Unauthorized modification or deletion of sensitive file

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 891ac62 and 48d12c4.

⛔ Files ignored due to path filters (1)

• package-lock.json is excluded by !**/package-lock.json

📒 Files selected for processing (2)

• .github/workflows/pull-request.yml (5 hunks)
• package.json (1 hunks)

🧰 Additional context used

🪛 GitHub Actions: PR Workflow

package.json

[error] Unauthorized modification or deletion of sensitive file

.github/workflows/pull-request.yml

[error] Unauthorized modification or deletion of sensitive file

🪛 YAMLlint (1.35.1)

.github/workflows/pull-request.yml

[error] 148-148: trailing spaces

(trailing-spaces)

---

[error] 214-214: trailing spaces

(trailing-spaces)

---

[error] 269-269: trailing spaces

(trailing-spaces)

---

[error] 498-498: no new line character at the end of file

(new-line-at-end-of-file)

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: Analyse Code With CodeQL (javascript)

🔇 Additional comments (1)

.github/workflows/pull-request.yml (1)

292-301: LGTM: GraphQL schema validation implementation.

Good addition of GraphQL schema validation steps:

1. Installing the inspector CLI
2. Validating schema.graphql existence
3. Running validation against GraphQL files

🧰 Tools

🪛 GitHub Actions: PR Workflow

[error] Unauthorized modification or deletion of sensitive file

[Priyanshuthapliyal2005]

@palisadoes can you add 'ignore-sensitive-files-pr' label over this pr

[Cioppolo14]

@Priyanshuthapliyal2005 Please fix the issue you are reference, it currently references a closed PR. Please do not assign reviewers and please fix all failed checks.

[palisadoes]

1. Closing.
2. Once again you have made wholesale changes to pull-request.yml which will cause the workflows to break.
3. In some cases you have changed the logic
4. In other cases you have removed functionality
5. Please be more careful and responsible about the quality of our code

[Priyanshuthapliyal2005]

I will review all the changes. I formatted the YML file, which caused changes throughout the code. I will take care of it this time.

[palisadoes]

Yes, but you also removed and modified previous functionality

[Priyanshuthapliyal2005]

Yes, but you also removed and modified previous functionality

Yeah , I have removed few dependency and functionality,
Like some python commands and graph ql inspector global dependency and many more

[palisadoes]

That was out of scope of the issue. It jeopardized the repo.

If you see functionality that needs fixing, then open an issue specific for that.

Validating multiple features on one PR is not optimal especially when there is no explanation of context.

Focus on the needs of the issue