v18 - Configure & Install docs-admin.talawa.io Docusaurus Site

[palisadoes]

What kind of change does this PR introduce?

These changes allow the creation of a new https://docs-admin.talawa.io documentation website

Issue Number:

• N/A

Did you add tests for your changes?

• Yes

Snapshots/Videos:

• N/A

If relevant, did you update the documentation?

• Yes

Summary

• These changes allow the creation of a new https://docs-admin.talawa.io documentation website

Does this PR introduce a breaking change?

• No

Other information

• N/A

Have you read the contributing guide?

• Yes

Summary by CodeRabbit

• New Features
  • Activated GitHub Actions workflows for code coverage testing and reporting.
• Bug Fixes
  • Updated environment name for the deployment job to ensure proper functionality.
• Chores
  • Cleaned up workflow configuration by uncommenting sections for clarity and enabling functionality.

[coderabbitai]

Warning

Rate limit exceeded

@palisadoes has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 25 minutes and 6 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 83ee2e0 and ba84930.

📒 Files selected for processing (2)

• .github/workflows/push-deploy-website.yml (1 hunks)
• .github/workflows/push.yml (1 hunks)

Walkthrough

The pull request modifies two GitHub Actions workflow configuration files. In push-deploy-website.yml, the environment name is updated from gh-pages to develop-postgres, with added comments clarifying environment naming requirements. The push.yml workflow is transformed from a commented-out state to an active configuration, enabling code coverage testing and reporting by uncommenting various sections and removing the Docusaurus deployment job.

Changes

File	Change Summary
.github/workflows/push-deploy-website.yml	Environment name changed from gh-pages to develop-postgres; added clarifying comments about environment naming
.github/workflows/push.yml	Uncommented entire workflow configuration; enabled code coverage job; removed Docusaurus deployment job

Possibly related PRs

• fix failing workflow of TS compilation #2472: Updates GitHub Actions workflow to enforce develop-postgres as the target branch for pull requests

Suggested reviewers

• pranshugupta54
• GlenDsza
• Doraemon012
• AVtheking
• gautam-divyanshu
• Atharva-Kanherkar

Poem

🐰 Workflows dance, comments unfurl
Code coverage springs, configurations swirl
From gh-pages to develop-postgres we leap
Uncommented paths, our CI secrets keep
A rabbit's deploy, swift and bright! 🚀

---

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

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.50%. Comparing base (113048d) to head (ba84930).
Report is 13 commits behind head on develop-postgres.

Additional details and impacted files

@@                  Coverage Diff                  @@
##           develop-postgres    #2969       +/-   ##
=====================================================
+ Coverage             38.68%   88.50%   +49.81%     
=====================================================
  Files                   299      320       +21     
  Lines                  7427     8288      +861     
  Branches               1624     1869      +245     
=====================================================
+ Hits                   2873     7335     +4462     
+ Misses                 4337      731     -3606     
- Partials                217      222        +5     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.