Skip to content

Add troubleshooting entry for load-test-ng and Mattermost version compatibility#978

Merged
fmartingr merged 3 commits intomasterfrom
readme/versioning
Mar 18, 2026
Merged

Add troubleshooting entry for load-test-ng and Mattermost version compatibility#978
fmartingr merged 3 commits intomasterfrom
readme/versioning

Conversation

@fmartingr
Copy link
Contributor

@fmartingr fmartingr commented Mar 17, 2026

Summary

  • Add a new troubleshooting entry to docs/faq.md documenting the 501 error when running load-test-ng v1.30.0+ against Mattermost servers older than v11.0.1
  • The GetClientConfig API changed in Mattermost v11.0.1; load-test-ng v1.30.0+ uses the new endpoint, causing failures on older servers
  • Recommends using load-test-ng v1.29.0 or earlier for pre-v11 deployments

Test plan

  • Verify the new FAQ entry renders correctly in markdown
  • Confirm the changelog link resolves to the correct releases page

Summary by CodeRabbit

  • Documentation
    • Minor README formatting cleanup for consistency.
    • Improved FAQ formatting for clarity and added a new entry explaining 501 errors when using load-test-ng v1.30.0+ against older servers, with recommended downgrade to v1.29.0 (or earlier) and links to relevant changelog/troubleshooting guidance.

…-ng and Mattermost server

Document the 501 error that occurs when running load-test-ng v1.30.0+ against
Mattermost servers older than v11.0.1 due to the GetClientConfig API change,
and recommend using v1.29.0 or earlier for pre-v11 deployments.
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds documentation to help users troubleshoot load-test-ng compatibility issues when running against older Mattermost server versions, and cleans up minor markdown formatting/whitespace.

Changes:

  • Re-indents markdown list/code blocks in docs/faq.md for cleaner rendering.
  • Adds a new FAQ troubleshooting entry describing a 501 error when load-test-ng v1.30.0+ targets Mattermost < v11.0.1, with a recommended workaround.
  • Removes trailing whitespace at the end of README.md.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File Description
docs/faq.md Markdown formatting tweaks + new troubleshooting entry for 501 errors due to Mattermost version/API compatibility.
README.md Removes a trailing blank/whitespace line at EOF.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 17, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 62e027ad-eafc-49b3-944e-cd5602bccbb7

📥 Commits

Reviewing files that changed from the base of the PR and between 73b484a and 579aac5.

📒 Files selected for processing (1)
  • docs/faq.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/faq.md

📝 Walkthrough

Walkthrough

Documentation-only changes: removed a trailing empty newline in README.md, adjusted code block indentation/spacing in docs/faq.md, and added a new FAQ subsection describing a compatibility issue between load-test-ng v1.30.0+ and Mattermost servers older than v11.0.1 with a recommended workaround.

Changes

Cohort / File(s) Summary
Documentation
README.md, docs/faq.md
Removed an empty trailing newline in README.md; reformatted code block indentation/spacing in docs/faq.md; added a FAQ subsection describing a 501 error when using load-test-ng v1.30.0+ against Mattermost < v11.0.1 and recommending v1.29.0 or earlier.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: adding a troubleshooting entry for load-test-ng and Mattermost version compatibility to the FAQ documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch readme/versioning
📝 Coding Plan
  • Generate coding plan for human review comments

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

fmartingr and others added 2 commits March 17, 2026 11:18
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@fmartingr fmartingr self-assigned this Mar 17, 2026
@fmartingr fmartingr merged commit b9e2b77 into master Mar 18, 2026
2 checks passed
@fmartingr fmartingr deleted the readme/versioning branch March 18, 2026 07:30
@agarciamontoro
Copy link
Member

Thank you for this, @fmartingr!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants