chore(performance): Create readmes for performance tests #750
Conversation
|
Warning Rate limit exceeded@dagfinno has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 14 minutes and 34 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the 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. 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThis pull request updates the project documentation by adding a new "Test" section to the main README that includes a "Performance tests" subsection. The new section points users to further details provided in a newly introduced README file. The added README file documents the performance testing of the Correspondence API, providing information on test scripts, prerequisites (such as Grafana K6 or Docker), and instructions for running tests via CLI and GitHub Actions. Changes
Suggested labels
Suggested reviewers
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
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (4)
Test/Altinn.Correspondence.LoadTests/correspondence/README.md (4)
12-18: Test Files List Formatting
The list of test files is complete and informative. However, consider replacing the dashes (-) with asterisks (*) for unordered list items to conform with markdownlint guidelines (MD004).🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
14-14: Unordered list style
Expected: asterisk; Actual: dash(MD004, ul-style)
15-15: Unordered list style
Expected: asterisk; Actual: dash(MD004, ul-style)
16-16: Unordered list style
Expected: asterisk; Actual: dash(MD004, ul-style)
17-17: Unordered list style
Expected: asterisk; Actual: dash(MD004, ul-style)
30-38: Get Correspondence Section: Consistency in Step Capitalization
The instructions outlining the "Get correspondence" test are clear. For enhanced readability, consider standardizing the capitalization of the steps (e.g., use either "get" or "Get" uniformly).
70-88: GitHub Action with act Instructions
The instructions for running the tests locally using GitHub Actions with act are detailed and helpful. One minor formatting note: the indented text following the fenced code block (around line 79) might benefit from being converted into standard paragraph text or a fenced block to ensure consistent formatting throughout the document.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
79-79: Code block style
Expected: fenced; Actual: indented(MD046, code-block-style)
80-80: Trailing punctuation in heading
Punctuation: '.'(MD026, no-trailing-punctuation)
80-80: Heading Trailing Punctuation
The heading on line 80 ("##### IMPORTANT: Ensure this file is added to .gitignore to prevent accidental commits of sensitive information. Never commit actual credentials to version control.") includes trailing punctuation. Consider removing the final period to conform with markdown style guidelines (MD026).🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
80-80: Trailing punctuation in heading
Punctuation: '.'(MD026, no-trailing-punctuation)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
README.md(1 hunks)Test/Altinn.Correspondence.LoadTests/correspondence/README.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
Test/Altinn.Correspondence.LoadTests/correspondence/README.md
14-14: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
15-15: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
16-16: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
17-17: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
79-79: Code block style
Expected: fenced; Actual: indented
(MD046, code-block-style)
80-80: Trailing punctuation in heading
Punctuation: '.'
(MD026, no-trailing-punctuation)
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: Analyze (javascript-typescript)
- GitHub Check: Analyze (csharp)
🔇 Additional comments (9)
README.md (1)
30-36: New Performance Tests Section Addition
The addition of the "Test" section with a "Performance tests" subsection is clear and improves the discoverability of performance testing documentation. Please verify that the relative path (./Test/Altinn.Correspondence.LoadTests/correspondence/README.md) is correct relative to the repository root.Test/Altinn.Correspondence.LoadTests/correspondence/README.md (8)
5-11: Prerequisites Section is Clear
The prerequisites section provides a clear list of requirements (Grafana K6 or Docker, and the shell environments). The use of asterisks here is appropriate and maintains clarity.
19-24: Create Correspondence Description
The "Create correspondence" section provides succinct instructions that are easy to follow.
25-29: Create and Upload Correspondence Instructions
The "Create and upload correspondence" section is well-documented. Please ensure that the file name inconsistency noted in the introduction is resolved.
39-44: Get Correspondence Overview Section
The "Get correspondence overview" section is clear and provides complete instructions for the intended test operations.
47-63: Run Test Section – CLI Instructions
The CLI instructions for running the performance tests are comprehensive and well-structured. This will help users execute the tests directly from the command line without ambiguity.
64-69: GitHub Actions Instructions
The section detailing how to run tests via GitHub Actions is clear and concise.
89-96: Example Command Clarity
The example command is well-documented and provides a practical reference for users.
97-99: Test Results Section
The Test Results section effectively directs users to the locations where they can find detailed output from the performance tests.
Description
Added readme for performance-tests (and reference to readme from root readme)
Related Issue(s)
Verification
Documentation
Summary by CodeRabbit