deploy error solved, push-deploy-website.yml updated #3364
Conversation
WalkthroughThis pull request involves updates to the GitHub Actions workflow for website deployment and the addition of several documentation files for mock variables in the OrganizationTags component. The workflow file has been modified to use Node.js version 20.x and switch from Yarn to npm for package management. Multiple new documentation files have been created to describe mock variables used in testing, providing detailed type and structure information for various scenarios in the OrganizationTags module. Changes
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
📜 Recent review detailsConfiguration used: .coderabbit.yaml 📒 Files selected for processing (1)
🧰 Additional context used🪛 yamllint (1.35.1).github/workflows/push-deploy-website.yml[error] 41-41: trailing spaces (trailing-spaces) [error] 56-56: no new line character at the end of file (new-line-at-end-of-file) ⏰ Context from checks skipped due to timeout of 90000ms (3)
🔇 Additional comments (1)
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
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (2)
docs/docs/auto-docs/screens/OrganizationTags/OrganizationTagsMocks/variables/MOCKS_NO_MORE_PAGES.md (1)
7-7: Improve type signature readability.The type signature is complex and hard to read due to excessive escaping of underscores and nested type information. Consider using a code block with proper TypeScript syntax highlighting for better readability.
-`const` **MOCKS\_NO\_MORE\_PAGES**: (\{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `after`: `undefined`; `first`: `number`; `id`: `string`; `sortedBy`: \{ `id`: `string`; \}; `where`: \{ `name`: \{ `starts_with`: `string`; \}; \}; \}; \}; `result`: \{ `data`: \{ `organizations`: `object`[]; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `after`: `string`; `first`: `number`; `id`: `string`; `sortedBy`: \{ `id`: `string`; \}; `where`: \{ `name`: \{ `starts_with`: `string`; \}; \}; \}; \}; `result`: \{ `data`: `any`; \}; \})[] +```typescript +const MOCKS_NO_MORE_PAGES: Array<{ + request: { + query: DocumentNode; + variables: { + after: undefined | string; + first: number; + id: string; + sortedBy: { + id: string; + }; + where: { + name: { + starts_with: string; + }; + }; + }; + }; + result: { + data: { + organizations: object[]; + } | any; + }; +}> +```.github/workflows/push-deploy-website.yml (1)
41-41: Good choice switching to Node.js 20.x LTS!Using Node.js 20.x (LTS) instead of version 22 is a more stable choice for production deployments. However, there's a trailing space at the end of this line that should be removed.
- node-version: '20.x' + node-version: '20.x'🧰 Tools
🪛 yamllint (1.35.1)
[error] 41-41: trailing spaces
(trailing-spaces)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (7)
.github/workflows/push-deploy-website.yml(2 hunks)docs/docs/auto-docs/screens/OrganizationTags/OrganizationTagsMocks/variables/MOCKS_EMPTY.md(1 hunks)docs/docs/auto-docs/screens/OrganizationTags/OrganizationTagsMocks/variables/MOCKS_ERROR.md(2 hunks)docs/docs/auto-docs/screens/OrganizationTags/OrganizationTagsMocks/variables/MOCKS_ERROR_ERROR_TAG.md(1 hunks)docs/docs/auto-docs/screens/OrganizationTags/OrganizationTagsMocks/variables/MOCKS_NO_MORE_PAGES.md(1 hunks)docs/docs/auto-docs/screens/OrganizationTags/OrganizationTagsMocks/variables/MOCKS_NULL_END_CURSOR.md(1 hunks)docs/docs/auto-docs/screens/OrganizationTags/OrganizationTagsMocks/variables/MOCKS_UNDEFINED_USER_TAGS.md(1 hunks)
✅ Files skipped from review due to trivial changes (4)
- docs/docs/auto-docs/screens/OrganizationTags/OrganizationTagsMocks/variables/MOCKS_ERROR_ERROR_TAG.md
- docs/docs/auto-docs/screens/OrganizationTags/OrganizationTagsMocks/variables/MOCKS_NULL_END_CURSOR.md
- docs/docs/auto-docs/screens/OrganizationTags/OrganizationTagsMocks/variables/MOCKS_UNDEFINED_USER_TAGS.md
- docs/docs/auto-docs/screens/OrganizationTags/OrganizationTagsMocks/variables/MOCKS_EMPTY.md
🧰 Additional context used
📓 Learnings (2)
docs/docs/auto-docs/screens/OrganizationTags/OrganizationTagsMocks/variables/MOCKS_NO_MORE_PAGES.md (1)
Learnt from: arpit-chakraborty
PR: PalisadoesFoundation/talawa-admin#3158
File: src/screens/OrganizationTags/OrganizationTagsMocks.ts:384-524
Timestamp: 2025-01-15T05:39:30.480Z
Learning: In OrganizationTagsMocks.ts, MOCKS_NULL_END_CURSOR and MOCKS_NO_MORE_PAGES are designed to test UI handling of edge cases where pagination data is inconsistent (e.g., hasNextPage is true but endCursor is null, or next page returns undefined data).
docs/docs/auto-docs/screens/OrganizationTags/OrganizationTagsMocks/variables/MOCKS_ERROR.md (2)
Learnt from: arpit-chakraborty
PR: PalisadoesFoundation/talawa-admin#3158
File: src/screens/OrganizationTags/OrganizationTagsMocks.ts:384-524
Timestamp: 2025-01-15T05:39:30.480Z
Learning: In OrganizationTagsMocks.ts, MOCKS_NULL_END_CURSOR and MOCKS_NO_MORE_PAGES are designed to test UI handling of edge cases where pagination data is inconsistent (e.g., hasNextPage is true but endCursor is null, or next page returns undefined data).
Learnt from: meetulr
PR: PalisadoesFoundation/talawa-admin#2355
File: src/screens/ManageTag/ManageTagMocks.ts:187-269
Timestamp: 2024-11-12T10:40:58.654Z
Learning: In `src/screens/ManageTag/ManageTagMocks.ts`, when mocking data for `USER_TAGS_ASSIGNED_MEMBERS` and `USER_TAGS_MEMBERS_TO_ASSIGN_TO`, it's acceptable for user IDs to overlap because the queries serve different purposes and the overlapping IDs can represent realistic scenarios in tests.
🪛 yamllint (1.35.1)
.github/workflows/push-deploy-website.yml
[error] 41-41: trailing spaces
(trailing-spaces)
[error] 55-55: 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 (2)
docs/docs/auto-docs/screens/OrganizationTags/OrganizationTagsMocks/variables/MOCKS_ERROR.md (2)
9-9: LGTM! Source file line number updated correctly.The documentation accurately reflects the new location of the MOCKS_ERROR variable definition in the source file.
35-35: Verify the error scenario coverage.The change from 'orgId' to 'orgIdError' makes the mock's purpose clearer by indicating it's specifically for error testing. This aligns with best practices for mock naming.
Let's verify this is used consistently in error test cases:
✅ Verification successful
The error scenario is properly covered and well-structured. The mock's ID change to 'orgIdError' improves clarity by explicitly indicating its purpose for error testing, and it's properly integrated into the test suite with appropriate error handling setup.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Check for consistent usage of 'orgIdError' in test files # Expected: Find test cases that verify error handling using this mock # Search for test files using this mock rg -l "MOCKS_ERROR" --glob "**/*.test.{ts,tsx}" # Search for the specific error scenario usage rg "orgIdError" --glob "**/*.{ts,tsx}" -C 3Length of output: 746
Script:
#!/bin/bash # Check the test file content and error scenario testing rg -A 10 "MOCKS_ERROR" src/components/TagActions/TagActions.test.tsx # Look for test descriptions related to error scenarios rg "describe|it.*error" src/components/TagActions/TagActions.test.tsx # Check the mock's definition cat src/screens/OrganizationTags/OrganizationTagsMocks.tsLength of output: 15217
...cs/auto-docs/screens/OrganizationTags/OrganizationTagsMocks/variables/MOCKS_NO_MORE_PAGES.md
Show resolved
Hide resolved
tasneemkoushar
merged commit ca806cc
into
PalisadoesFoundation:develop-postgres
This reverts commit ca806cc.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## develop-postgres #3364 +/- ##
=====================================================
+ Coverage 8.40% 89.75% +81.35%
=====================================================
Files 312 335 +23
Lines 8105 8612 +507
Branches 1801 1898 +97
=====================================================
+ Hits 681 7730 +7049
+ Misses 7347 627 -6720
- Partials 77 255 +178
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
What kind of change does this PR introduce?
Issue Number:
Fixes #
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?
Summary by CodeRabbit
Release Notes
Documentation
MOCKS_EMPTYMOCKS_ERRORMOCKS_ERROR_ERROR_TAGMOCKS_NO_MORE_PAGESMOCKS_NULL_END_CURSORMOCKS_UNDEFINED_USER_TAGSChores