Auto docs #3290
Auto docs #3290
Conversation
|
Important Review skippedMore than 25% of the files skipped due to max files limit. The review is being skipped to prevent a low-quality review. 218 files out of 300 files are above the max files limit of 75. Please upgrade to Pro plan to get higher limits. You can disable this status message by setting the 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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
Documentation and Community
|
Our Pull Request Approval ProcessThanks for contributing! Testing Your CodeRemember, your PRs won't be reviewed until these criteria are met:
Our policies make our code better. ReviewersDo not assign reviewers. Our Queue Monitors will review your PR and assign them.
Reviewing Your CodeYour reviewer(s) will have the following roles:
CONTRIBUTING.mdRead our CONTRIBUTING.md file. Most importantly:
Other
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## develop-postgres #3290 +/- ##
=====================================================
+ Coverage 8.56% 89.73% +81.17%
=====================================================
Files 309 332 +23
Lines 7954 8586 +632
Branches 1763 1898 +135
=====================================================
+ Hits 681 7705 +7024
+ Misses 7196 622 -6574
- Partials 77 259 +182
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
palisadoes
added
the
ignore-sensitive-files-pr
|
|
|
|
with readme:
without readme: |
|
need to make few more changes |
|
Let me know when this is ready. Are you working with @bint-Eve on this? It's best to have collaboration |
|
Yes, we discussed a few things. |
|
Is this working and ready to be merged? |
|
@palisadoes The problem is that with every commit, the whole docs gets updated, and this shouldn't happen, but only those docs should get generated whose .tsx files are changed. so I'm fixing it. |
.github/workflows/pull-request.yml
Outdated
| run: | | ||
| date > generated.txt | ||
| git config user.name "github-actions[bot]" | ||
| git config user.email "41898282+github-actions[bot]@users.noreply.github.com" |
There was a problem hiding this comment.
- According to this GitHub example:
- The user should be:
{user.id}+{user.login}@users.noreply.github.com
There was a problem hiding this comment.
@palisadoes but the user is github bot, right?
so it's id and login is correct
There was a problem hiding this comment.
- The documentation states that you should be using the credentials of the user submitting the PR
- It implies that the email address should be the email address of the submitter too
.github/workflows/pull-request.yml
Outdated
| @@ -417,26 +417,59 @@ jobs: | |||
| docker stop talawa-admin-app-container | |||
| docker rm talawa-admin-app-container | |||
|
|
|||
| generate-docs: | |||
| runs-on: ubuntu-latest | |||
|
|
|||
There was a problem hiding this comment.
Add this. It makes most sense running this after all the tests are complete
needs: [Docker-Start-Check, Start-App-Without-Docker]
| git push | ||
| env: | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
|
|
||
| Test-Docusaurus-Deployment: | ||
| name: Test Deployment to https://docs-admin.talawa.io | ||
| runs-on: ubuntu-latest | ||
| needs: [Docker-Start-Check, Start-App-Without-Docker] |
There was a problem hiding this comment.
This should run after generate-docs
needs: [generate-docs]
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
|
@palisadoes I am just testing the workflow for now, will resolve these |
|
@palisadoes having problems in commiting,
|
It's referencing your repo not PalisadoesFoundation |
|
@palisadoes but don't we need to commit on pr branch and when pr gets merge, docs will also gets merge, |
|
@palisadoes when i use this, error: |
|
Please refer to this successful PR using the same strategy. @bint-Eve FYI |
|
@palisadoes still failing, |
|
Why didn't it fail here? It's a similar PR |
Yeah, that's what I am wondering. |
|
Should we proceed with the husky approach? |
|
No, we have a know working case in our repos |
|
What should I do now? |
|
|
@palisadoes While merging the PR in Talawa, it didn't fail because there were no changes to commit.
you can see no commit here.
|
|
GitHub wouldn't post the solution if it didn't work. Referring to this: Some questions:
|
What kind of change does this PR introduce?
Issue Number:
Fixes #2970
Snapshots/Videos:
If relevant, did you update the documentation?
Summary
Does this PR introduce a breaking change?
Checklist
CodeRabbit AI Review
Test Coverage
Other information
Have you read the contributing guide?