diff --git a/docs/FAQ/index.md b/docs/FAQ/index.md new file mode 100644 index 000000000..a9faedc6f --- /dev/null +++ b/docs/FAQ/index.md @@ -0,0 +1,72 @@ +--- +sidebar_position: 21 +sidebar_label: FAQ +--- + +# FAQ + +On this page, we have put together a list of the most frequently asked questions. Here, you can find prompt responses. + +**1. Does on-prem installed ReportPortal make any external calls? What are the content and nature of these calls? ** + +All test results and testing data reside in-house, within your instance of ReportPortal. However, there are two types of external calls that ReportPortal makes. The first checks our status page for the latest version and informs users of it on the login page. The second sends anonymized data to [Google Analytics](/terms-and-conditions/GoogleAnalyticsUsageByReportPortal), helping us refine the user experience and better understand application usage. This can be toggled off if desired. + +**2. Assuming ReportPortal locally caches logs to understand their content, where are these stored, and what are the associated retention policies?** + +ReportPortal utilizes PostgreSQL for its database, MinIO and the local system for file storage, and Elasticsearch for log indexing and ML processes. + +Retention policies can be set and adjusted within the application on a per-project basis. + +**3. How is data encrypted in transit and at rest?** + +We use encryption in transit via SSL for our SaaS instances. For on-prem installation it depends on your LoadBalancer. + +We use encryption at rest for our SaaS instances. It is provided by AWS and configured during VM provisioning. For on-prem installation it depends on your DevOps. + +**4. Does the containerized solution function as a standalone, or can it be integrated with K8S or other orchestration platforms? Is there a helm chart available?** + +ReportPortal is containerized and can be orchestrated using either docker-compose or [Kubernetes](https://github.com/reportportal/kubernetes/tree/develop/reportportal). + +**5. Is there any training available to use ReportPortal effectively?** + +Check our [Tutorial](/reportportal-tutorial/) and read [blog post](https://reportportal.io/blog/Tips-to-get-ReportPortal-benefits) with tips to get ReportPortal benefits. We also recommend investigate [our documentation](https://reportportal.io/docs/) where you can find screenshots and video instructions on ReportPortal functionality. + +**6. Is there a demo available?** + +For sure, you can explore ReportPortal [without installation](/reportportal-tutorial/#how-to-explore-reportportal-without-installation) visiting our Demo instance. + +**7. How can I begin using ReportPortal?** + +The initial steps involve installing and configuring the tool. [Installation steps](/category/installation-steps) you can find in our documentation. + +**8. Does the tool integrate with my existing test automation framework?** + +ReportPortal can be integrated with common testing frameworks and CI tools. Consult [this section](/log-data-in-reportportal/test-framework-integration) of the documentation for detailed information on test framework integration. And use following links for Integration with CI/CD: [Integration with GitLab CI](/quality-gates/IntegrationWithCICD/IntegrationWithGitLabCI/), [Integration with Jenkins](/quality-gates/IntegrationWithCICD/IntegrationWithJenkins/). + +**9. What type of license does ReportPortal use?** + +ReportPortal is licensed under Apache v2.0, which means it’s free to use, comes with no liability and warranty, and there is no service and support included. And can be utilized even for commercial usage. + +**10. Does ReportPortal have any paid features?** + +At that moment, we offer the only premium feature – [Quality Gates](/category/quality-gates). It is a set of predefined criteria that must be satisfied for a run to be deemed successful. + +**11. Does ReportPortal use AI?** + +We provide ML-driven failure triage. Read [this article](https://reportportal.io/blog/How-we-use-AI) to know how we use AI. + +**12. Do we need specific infrastructure prerequisites to avoid performance problems?** + +Look into [Optimal Performance Hardware setup](/installation-steps/OptimalPerformanceHardwareSetup). + +**13. What types of reports can I generate with the ReportPortal?** + +ReportPortal has a lot of widgets to visualize test results and understand the state of the product. Most popular our widgets: [Overall statistics chart](/dashboards-and-widgets/OverallStatistics), [Launch statistics chart](/dashboards-and-widgets/LaunchStatisticsChart), [Failed cases trend chart](/dashboards-and-widgets/FailedCasesTrendChart), [Launch execution and issue statistic](/dashboards-and-widgets/LaunchExecutionAndIssueStatistic), [Component health check](/dashboards-and-widgets/ComponentHealthCheck). + +**14. Can ReportPortal aggregate performance test results?** + +We do not support direct integration with performance testing frameworks, but as a workaround you can import performance test results in JUnit format into ReportPortal. Further information on this topic can be found [here](https://github.com/reportportal/reportportal/issues/1820). + +**15. Does ReportPortal have integration with Jira?** + +Our test automation reporting dashboard have integration with following Bug Tracking Systems: [Jira Server](/plugins/AtlassianJiraServer), [Jira Cloud](/plugins/AtlassianJiraCloud), [Azure DevOps](/plugins/AzureDevOpsBTS), and [Rally](/plugins/Rally). diff --git a/docs/admin-panel/_category_.json b/docs/admin-panel/_category_.json index 280bcc43a..951bb6316 100644 --- a/docs/admin-panel/_category_.json +++ b/docs/admin-panel/_category_.json @@ -1,6 +1,6 @@ { "label": "Admin Panel", - "position": "12", + "position": "14", "link": { "type": "generated-index" } diff --git a/docs/analysis/_category_.json b/docs/analysis/_category_.json index da944b5e6..7ee89eff0 100644 --- a/docs/analysis/_category_.json +++ b/docs/analysis/_category_.json @@ -1,6 +1,6 @@ { "label": "Analysis", - "position": "8", + "position": "11", "link": { "type": "generated-index" } diff --git a/docs/case-studies/_category_.json b/docs/case-studies/_category_.json index 520d93b41..e5f4bc931 100644 --- a/docs/case-studies/_category_.json +++ b/docs/case-studies/_category_.json @@ -1,6 +1,6 @@ { "label": "Case Studies", - "position": "16", + "position": "19", "link": { "type": "generated-index" } diff --git a/docs/dashboards-and-widgets/_category_.json b/docs/dashboards-and-widgets/_category_.json index 649102c64..a777ce85a 100644 --- a/docs/dashboards-and-widgets/_category_.json +++ b/docs/dashboards-and-widgets/_category_.json @@ -1,6 +1,6 @@ { "label": "Dashboards and widgets", - "position": "10", + "position": "13", "link": { "type": "generated-index" } diff --git a/docs/dev-guides/_category_.json b/docs/dev-guides/_category_.json index 3b34ebbb4..523cfebf6 100644 --- a/docs/dev-guides/_category_.json +++ b/docs/dev-guides/_category_.json @@ -1,6 +1,6 @@ { "label": "Developers guides", - "position": "7", + "position": "9", "link": { "type": "generated-index" } diff --git a/docs/features/AIFailureReasonDetection.md b/docs/features/AIFailureReasonDetection.md new file mode 100644 index 000000000..dd6f0be52 --- /dev/null +++ b/docs/features/AIFailureReasonDetection.md @@ -0,0 +1,32 @@ +--- +sidebar_position: 3 +sidebar_label: AI failure reason detection +--- + +# AI-based failure reason detection + +In the realm of test automation, failure analysis often becomes a bottleneck, consuming valuable time and resources. ReportPortal introduces a game-changing solution with its AI-powered failure reason detection feature. Employing advanced Machine Learning (ML) algorithms, this feature streamlines your test processes, enabling quicker, more accurate results. + +**Unlocking Efficiency through Automation** + +Running daily regression tests can be a double-edged sword: they're essential for maintaining a robust application, but they also generate an avalanche of test results that need analysis. The good news? ReportPortal's AI algorithms take over this repetitive task, automatically categorizing test failures according to their root cause. As a result, your team can shift their focus to newly emerged issues, substantially cutting down the time spent on manual triage. + +**Speed and Precision in Defect Identification** + +The power of AI doesn't stop at handling daily jobs; it extends to making your defect identification process lightning-fast and razor-sharp. ReportPortal's Auto-Analysis feature scans through test results, logs, and other associated data to quickly pinpoint failures and automatically tag them with defect types. This efficiency enables your team to discover a maximum number of bugs in minimal time, supercharging your QA process. + +**Elevated Accuracy in Failure Classification** + +Human error is an inevitable part of any process, particularly one as monotonous as going through lines of test logs. ReportPortal's AI-driven approach minimizes this risk. By automating the classification of test failures, it not only eliminates manual errors but also adds an extra layer of precision that even the most experienced testers might miss. + +ReportPortal's AI functionality comes in three distinct forms to accommodate various testing needs: + +- **Analyzer:** This feature automatically classifies test failures, sparing your team the manual labor of sifting through results. Utilizing advanced algorithms, the Analyzer categorizes different types of test failures, so you can prioritize issues that need immediate attention. +- **Unique Error:** This tool groups identical test failures together for accelerated bulk analysis. By clustering similar failures, Unique Error allows for more efficient troubleshooting and quicker resolution of recurring issues. +- **ML-Based Suggestions:** Leveraging machine learning algorithms, this feature provides suggestions for failures that are most similar to ones you've encountered before while do manual analysis. The suggestions guide your team in identifying the root causes of test failures more accurately and swiftly. + +**Conclusion: A Smarter Way to Test** + +AI-based failure reason detection is more than just a flashy feature. First deployed in production in 2016, long before the hype cycle surrounding GenAI technology. It's a strategic asset that enhances team productivity and the reliability of your applications. By automating the most cumbersome aspects of test analysis, ReportPortal frees up your team to focus on what truly matters: delivering high-quality software. + +Embrace the future of test automation with ReportPortal's AI capabilities and give your team the edge they've been waiting for. diff --git a/docs/features/CategorisationOfFailures.md b/docs/features/CategorisationOfFailures.md new file mode 100644 index 000000000..6ec57fc5d --- /dev/null +++ b/docs/features/CategorisationOfFailures.md @@ -0,0 +1,31 @@ +--- +sidebar_position: 2 +sidebar_label: Categorisation of failures +--- + +# Categorization of failures based on issue roots + +In the realm of software development and QA, test failure analysis isn't just a task—it's a critical practice. The way we categorize test failures informs not only the testing process but also how quickly and efficiently developers can resolve issues. ReportPortal provides an advanced, feature-rich environment for streamlined failure categorization, which is an integral part of any agile development cycle. + +Navigate to the 'Launches' tab in ReportPortal and you'll find an intuitive breakdown of your test executions, displaying Total, Passed, Failed, and Skipped test cases. What sets ReportPortal apart is its pre-categorized issues like Product Bug, Automation Bug, and System Issue. This leaves your team with a focused subset of items marked “To Investigate.” + +**The Process of Intelligent Triage** + +When you open one of these “To Investigate” items, a QA engineer engages in defect triage by reviewing logs, screenshots, and video recordings, all of which are seamlessly integrated into each failed test item. Based on this comprehensive analysis, the engineer categorizes the failures through the “Make Decision” modal, as follows: + +- **Product Bug:** These issues stem from flaws in the application code and should be the developers' first priority for resolution. +- **Automation Bug:** This category addresses issues related to test data, such as outdated tests or incorrect data, and timeouts. +- **System Issue:** Failures in this category usually result from an unstable testing environment or issues with third-party software. +- **Not a Defect:** Use this classification for tests that have been resolved or manually validated. + +**The Takeaways** + +Intelligent categorization with ReportPortal serves several essential functions: + +**1. Root Cause Analysis:** The key question remains: Was the failure caused by an issue within the software, or was it an external factor? With access to detailed logs, screenshots, and video, pinpointing the root cause becomes a far more efficient process. + +**2. Functional Area Identification:** Categorizing failures often reveals which area of the application is prone to issues, allowing for targeted remediation. + +**3. Severity Assessment:** Understanding the severity of a failure is critical. Is it an application issue that mandates postponing deployment, or is it a lesser issue that can be prioritized accordingly? + +In summary, the intelligent test failure categorization offered by ReportPortal is a cornerstone for delivering high-quality products swiftly and effectively. diff --git a/docs/features/QualityGates.md b/docs/features/QualityGates.md new file mode 100644 index 000000000..3b9a07a3f --- /dev/null +++ b/docs/features/QualityGates.md @@ -0,0 +1,24 @@ +--- +sidebar_position: 7 +sidebar_label: Quality Gates +--- + +# Quality Gates + +Quality Gates is a feature thanks to which ReportPortal becomes an integral part of continuous testing platform. It prevents the code from moving forward if it doesn’t meet testing criteria. ReportPortal uses aggregated data and rule engine to verify testing results against required conditions. + +Top-3 benefits of Quality Gates: + +**Increased Speed and Efficiency** + +Automated GO / NO-GO decisions enable quick decision-making by instantly evaluating whether a particular build or code change meets the predefined quality criteria while tested. This eliminates the need for manual reviews at various stages of the process, allowing teams to release software more quickly and efficiently and avoid delays and human error. + +**Improved Consistency and Reliability** + +By setting standardized quality criteria, automated quality gates ensure that each code change adheres to the same high-quality standards. This consistency helps to reduce the likelihood of defects and errors, making the end product more reliable and robust. + +**Enhanced Collaboration and Accountability** + +Automated quality gates provide immediate, objective feedback that is accessible to all team members, from developers to QA to management. This shared understanding of what constitutes "quality" improves collaboration and holds everyone accountable for the quality of the software. + +In summary, Quality Gates are an essential feature in ReportPortal that helps to understand the quality of your product and make release decisions. diff --git a/docs/features/RESTAPI.md b/docs/features/RESTAPI.md new file mode 100644 index 000000000..3877103dc --- /dev/null +++ b/docs/features/RESTAPI.md @@ -0,0 +1,30 @@ +--- +sidebar_position: 7 +sidebar_label: REST API +--- + +# REST API + +ReportPortal offers a robust set of features through its REST API, covering test data, user data, project data, statistics, integrations, and more. + +The REST API can be particularly useful for those looking to: + +- Implement own reporter and integrate it with a custom testing framework or runner. +- Retrieve data from ReportPortal for custom reports or integration with third-party systems. +- Enhance functionality and develop add-ons. + +Here are the examples of how REST API can be helpful, including: + +**1. Creating/updating test results**, test runs, logs, adding attachments, and comments, and other information as attributes. It improves the testing process in general by supplying more context and information about the test results. + +**2. Integration with test management tools** (Jira, TestRail, and others). It allows to collect and manage test results and other data in one place. + +**3. Integration with bug tracking systems** (Jira Server, Jira Cloud, Azure DevOps, Rally, and others). This makes it possible to easily track issues. + +**4. Integration with CI/CD pipelines** (Jenkins, Travis CI, TeamCity, and others) for the real-time test results, faster feedback and quicker release cycles. + +**5. Integration with other systems** like Data Mart (Microsoft Dynamics, Power BI, Vertica). They serve for extensive data analysis. + +**6. Custom integration.** With REST API, you can create your own extensions. For example, if here there is no integration with specific test framework that you need, you can make any integration using API. + +Generally, REST API can be used for getting the most out of the test automation reporting tools such as ReportPortal and for the extension of capabilities. REST API allows to track and manage bugs in one central area, to design unique reports and dashboards that might offer insightful data and assist teams in making better decisions regarding the testing process. diff --git a/docs/features/RealTimeReporting.md b/docs/features/RealTimeReporting.md new file mode 100644 index 000000000..f238e26ff --- /dev/null +++ b/docs/features/RealTimeReporting.md @@ -0,0 +1,26 @@ +--- +sidebar_position: 5 +sidebar_label: Real-time reporting +--- + +# Real-time reporting + +Real-time test reporting provides the most current data without delay. Thanks to near real-time capabilities, you can receive the first test results in a matter of seconds after the execution has started and benefit from the advantage of getting the entire execution results before it is completed. + +Real-time reporting in ReportPortal comes with three main advantages: + +**Saving time on early reaction and Early Defect Identification** + +With test case results and logs appearing in ReportPortal in real-time, teams can begin triaging issues immediately. This not only saves time but also allows for early identification of defects, leading to quicker resolutions and improved code quality. + +At the same time, you can save time and effort with manual re-testing of failed test cases, while the entire execution is still on the go. + +**Maximized Testing Efficiency for Large Regressions** + +For extensive regression tests that may take several hours to complete, real-time reporting ensures that teams don't have to wait until the end to start analyzing results. They can begin the analysis while the rest of the tests are still running, thereby making optimal use of time and resources. + +**Streamlined Workflow with Continuous Feedback:** + +The real-time nature of the reporting enables a continuous feedback loop among testers, developers, and other stakeholders. This makes it easier to implement changes on the fly and ensures that everyone stays informed, reducing the likelihood of surprises at the end of the regression cycle. + +Overall, real-time reporting provides easy access to test results as soon as they are generated, allows to quickly identify issues and make decisions, reduces costs by preventing similar issues and ensures effective communication between team and stakeholders. diff --git a/docs/features/RichArtifactsInTestReports.md b/docs/features/RichArtifactsInTestReports.md new file mode 100644 index 000000000..67d31908e --- /dev/null +++ b/docs/features/RichArtifactsInTestReports.md @@ -0,0 +1,30 @@ +--- +sidebar_position: 4 +sidebar_label: Rich artifacts in test reports +--- + +# Rich artifacts in test reports + +Test execution report in ReportPortal may contain extra details in addition to the standard test results (passed/failed status). + +These additional artifacts in test reports can consist of: + +**1. Logs.** + +Logs can include error messages that are very helpful for test failure analysis. With logs, it is possible to understand the root cause and set the defect type properly. + +**2. Screenshots.** + +You can see the image of the data displayed on the screen during the test run. Screenshots make the debugging process easier and may give insights into why this issue occurred. + +**3. Video recordings.** + +Logs in ReportPortal can have video recordings attached as well. A video shows the exact screen states. Using this artifact, you will be able to troubleshoot problems more quickly. + +Besides, ReportPortal also supports integration with Sauce Labs via corresponding plugin so that it is possible to watch videos of test executions right in the ReportPortal. + +**4. Network traffic.** + +These are details about the network calls performed while the test was running (requests and responses). + +You can send all the artifacts to ReportPortal as attachments and use them to simplify defect triage, to replicate and debug issues, to find performance and network-related issues, to comprehend the context in which certain problems occurred. diff --git a/docs/features/UnifiedTestReporting.md b/docs/features/UnifiedTestReporting.md new file mode 100644 index 000000000..b5ef01acb --- /dev/null +++ b/docs/features/UnifiedTestReporting.md @@ -0,0 +1,25 @@ +--- +sidebar_position: 1 +sidebar_label: Unified test reporting +--- + +# Single-entry point and unified test reporting + +ReportPortal was created with the idea in mind to be a single tool to acquire and aggregate the results of all automated tests for projects. Our centralized test automation tool is a great focus area for managers and test engineers because all test results can be accessed, reviewed and analyzed in one place. + +In the complex landscape of software testing, where multiple test frameworks, languages, and types of tests often coexist, the sheer volume and diversity of test reports can be overwhelming. ReportPortal addresses this problem elegantly by serving as a single-entry point for all test reports, providing unified and consolidated insights across the board. This single point of truth offers a multitude of benefits that can transform the way your team approaches testing. + +**Unification and Standardization** + +ReportPortal is designed to unify reports from various test frameworks and languages, whether they are API tests, integration tests, or end-to-end tests. It takes these disparate reports and presents them in a standardized format, making them equally understandable to QA engineers, developers, and even DevOps teams. This eliminates the need for engineers to scour multiple platforms for hidden reports, thereby reducing confusion and promoting efficiency. + +**Streamlined Collaboration** + +With a single link, you can direct team members to a central location where test results are not just collected but also analyzed. This facilitates collaboration by creating a universal language and understanding of test results across different team members, irrespective of their roles or technical proficiencies. The centralized reporting also aids in "Shift Left" testing approaches, where test feedback is made available earlier in the development cycle by Developers and not only QA Engineers. + +**Immediate Feedback and Quality Gate Integration** + +When combined with automated quality gates, the platform can provide instantaneous verdicts on whether code changes have passed or failed the tests. In the event of a failure, the platform's auto-analysis feature helps to pinpoint the exact cause. This real-time, automated feedback is invaluable in modern DevOps pipelines, accelerating the release process and enhancing code quality. + +In summary, ReportPortal’s single-entry point for all test reports offers the unique advantage of consolidating, standardizing, and analyzing test data in one location. This unified approach significantly simplifies the testing process, fosters better collaboration, and enables more agile development cycles. Adopting ReportPortal is a strategic move toward a more efficient and streamlined testing environment. + diff --git a/docs/features/VisualisationOfTestResults.md b/docs/features/VisualisationOfTestResults.md new file mode 100644 index 000000000..6ae4610a8 --- /dev/null +++ b/docs/features/VisualisationOfTestResults.md @@ -0,0 +1,26 @@ +--- +sidebar_position: 6 +sidebar_label: Visualisation of test results +--- + +# Visualization of test data + +ReportPortal's dynamic visualization capabilities provide teams with real-time insights, enabling them to make informed decisions quickly and efficiently. + +**Real-Time Dashboards and Widgets** + +One of ReportPortal's most compelling features is its real-time dashboards and widgets. These dashboards can be customized to focus on specific test executions or take a broader view at the build level by consolidating multiple executions. As your tests run, widgets update in real-time, ensuring your data is always current. This eliminates the cumbersome task of having to recreate reports for every testing cycle or regression. + +**Versatile Tracking** + +ReportPortal's widgets are designed to track essential metrics and trends in your test results. Whether you are interested in code coverage, performance metrics, or failure trends, there's a widget to help you monitor it. The real-time aspect ensures that any shifts in these metrics are immediately visible, allowing your team to adapt and respond more quickly than ever before. + +**Eye-Opening Insights** + +The platform goes beyond just displaying test results; it offers deep insights into the technical debt of your test automation. Widgets can break down test failures by different categories, such as environmental issues, automation errors, or actual product bugs. This classification empowers teams to understand where their efforts are most needed and helps them prioritize tasks effectively. + +**Demonstrating ROI of test automation** + +Perhaps the most critical advantage is the ability to highlight the return on investment (ROI) of your test automation. By showing the actual number of failures due to product bugs, ReportPortal makes it easier to quantify the value your testing is bringing to the overall project. + +In conclusion, ReportPortal’s visualization capabilities offer real-time, customizable, and insightful views into your test data. These features not only save time but also provide teams with the insights needed to deliver better software, faster. diff --git a/docs/features/_category_.json b/docs/features/_category_.json new file mode 100644 index 000000000..3b6204fce --- /dev/null +++ b/docs/features/_category_.json @@ -0,0 +1,7 @@ +{ + "label": "Features", + "position": "2", + "link": { + "type": "generated-index" + } +} diff --git a/docs/installation-steps/_category_.json b/docs/installation-steps/_category_.json index aae8775c4..9c49281f5 100644 --- a/docs/installation-steps/_category_.json +++ b/docs/installation-steps/_category_.json @@ -1,6 +1,6 @@ { "label": "Installation Steps", - "position": "3", + "position": "4", "link": { "type": "generated-index" } diff --git a/docs/issues-troubleshooting/_category_.json b/docs/issues-troubleshooting/_category_.json index d48114961..299b06353 100644 --- a/docs/issues-troubleshooting/_category_.json +++ b/docs/issues-troubleshooting/_category_.json @@ -1,6 +1,6 @@ { "label": "Issues Troubleshooting", - "position": "15", + "position": "18", "link": { "type": "generated-index" } diff --git a/docs/log-data-in-reportportal/ImportDataToReportPortal.mdx b/docs/log-data-in-reportportal/ImportDataToReportPortal.mdx index 5128429d0..db12a1e53 100644 --- a/docs/log-data-in-reportportal/ImportDataToReportPortal.mdx +++ b/docs/log-data-in-reportportal/ImportDataToReportPortal.mdx @@ -57,7 +57,7 @@ Here's an example of a request to the endpoint: ```yaml curl -X 'POST' \ - 'http://localhost:8585/api/v1/testProject/launch/import?attributeKey=someKey&attributeValue=someValue&description=someDescription&launchName=someName&skippedIsNotIssue=true' + 'http://localhost:8585/api/v1/testProject/launch/import?attributeKey=someKey&attributeValue=someValue&description=someDescription&launchName=someName&skippedIsNotIssue=true' \ -F 'file=@Launch.zip;type=application/x-zip-compressed' ``` diff --git a/docs/log-data-in-reportportal/_category_.json b/docs/log-data-in-reportportal/_category_.json index e27add91a..b3f0be38c 100644 --- a/docs/log-data-in-reportportal/_category_.json +++ b/docs/log-data-in-reportportal/_category_.json @@ -1,6 +1,6 @@ { "label": "Log data in ReportPortal", - "position": "6", + "position": "8", "link": { "type": "generated-index" } diff --git a/docs/plugins/AtlassianJiraServer.mdx b/docs/plugins/AtlassianJiraServer.mdx index 9504f42aa..320cd0ec6 100644 --- a/docs/plugins/AtlassianJiraServer.mdx +++ b/docs/plugins/AtlassianJiraServer.mdx @@ -209,9 +209,9 @@ https://jira.company.com/jira https://jiraeu.company.com ``` -3. Verify the project key in JIRA Server is correct. Please fill in the Project key field with project key-value, e.g. project ABC-DEF has key ABCDEF. +2. Verify the project key in JIRA Server is correct. Please fill in the Project key field with project key-value, e.g. project ABC-DEF has key ABCDEF. -4. Verify the username and password data. Make sure, that the login name and not the email are in the username field. In case all the data above is correct, but the error appears again, check whether the user's credentials to JIRA Server are not expired. As far as JIRA Server sends the request in HTML format, we are not able to display the real reason for the error. To check and/or resolve the issue, please do the next steps: +3. Verify the username and password data. Make sure, that the login name and not the email are in the username field. In case all the data above is correct, but the error appears again, check whether the user's credentials to JIRA Server are not expired. As far as JIRA Server sends the request in HTML format, we are not able to display the real reason for the error. To check and/or resolve the issue, please do the next steps: * Open JIRA Server page * Log in to JIRA Server with domain credentials using basic authorization (i.e., fill in user's login name and password into the fields) @@ -220,7 +220,7 @@ https://jiraeu.company.com * Submit the credentials again * Now try to establish the connection to JIRA Server on the ReportPortal project. -5. SSL instance of JIRA (even cloud version) can be accessed by JIRA API token, used instead of a password. +4. SSL instance of JIRA (even cloud version) can be accessed by JIRA API token, used instead of a password. After you have connected Jira and our test automation results dashboard, you can choose an issue type that you will be able to add to Jira during the “Post Issue” operation. Also, the user can add predefined fields that the user can fill. ## Post issue to Atlassian Jira Server diff --git a/docs/plugins/_category_.json b/docs/plugins/_category_.json index 2cf8c1884..9d3a53cc4 100644 --- a/docs/plugins/_category_.json +++ b/docs/plugins/_category_.json @@ -1,6 +1,6 @@ { "label": "Plugins", - "position": "13", + "position": "15", "link": { "type": "generated-index" } diff --git a/docs/quality-gates/IntegrationWithCICD/IntegrationWithGitLabCI.md b/docs/quality-gates/IntegrationWithCICD/IntegrationWithGitLabCI.md index 6c194e1eb..9e2984dea 100644 --- a/docs/quality-gates/IntegrationWithCICD/IntegrationWithGitLabCI.md +++ b/docs/quality-gates/IntegrationWithCICD/IntegrationWithGitLabCI.md @@ -289,13 +289,13 @@ UUID, which is a unique Launch identifier. Every Java Agent has specific properties which control Launch UUID printing, since July 2023. To ensure that check if your Agent has -the `com.epam.reportportal:client-java` library dependency of version 5.1.21 or +the `com.epam.reportportal:client-java` library dependency of version 5.1.23 or late. It’s generally safe to add exclusion and put a newer version of the library to get new features. So these properties are: `rp.launch.uuid.print` and `rp.launch.uuid.print.output`. You can put them into your `reportportal.properties` file. Enable Launch UUID printing with the property: `rp.launch.uuid.print = true`. It will output a line like this into the console: -`Report Portal Launch UUID: 61ce1c26-842a-4bde-9abe-a4696e31d626`. +`ReportPortal Launch UUID: 61ce1c26-842a-4bde-9abe-a4696e31d626`. Our tests use Gradle to build and run them, unlike other build systems Gradle usually hides test output streams and just prints truncated stack trace in case @@ -330,7 +330,7 @@ test: - chmod +x ./gradlew - ./gradlew --console=plain :service-api:demoSmoke -Prp.api.key=$RP_DEMO_KEY -Prp.admin.password=$RP_ADMIN_PASSWORD | tee ./console.log - > - sed -rn 's/[ ]+Report Portal Launch UUID: ([^\\r\\n]+)/LAUNCH_UUID=\1/ w launch.env' ./console.log + sed -rn 's/[ ]+ReportPortal Launch UUID: ([^\\r\\n]+)/LAUNCH_UUID=\1/ w launch.env' ./console.log ``` Some explanations here: @@ -342,11 +342,11 @@ Some explanations here: ### Getting Launch UUID for Python tests ReportPortal pytest agent has specific properties which control Launch UUID printing, -since version 5.2.0: `rp_launch_uuid_print` and `rp_launch_uuid_print_output`. +since version 5.2.2: `rp_launch_uuid_print` and `rp_launch_uuid_print_output`. You can put them into your `pytest.ini` file. For this example, we just need one of them: `rp_launch_uuid_print = True`. It will output a line like this into the console: -`Report Portal Launch UUID: 61ce1c26-842a-4bde-9abe-a4696e31d626`. +`ReportPortal Launch UUID: 61ce1c26-842a-4bde-9abe-a4696e31d626`. Next, we need to save this UUID to an environment variable which we later will use in a separate stage in polling ReportPortal API. GitLab allows this with [dotenv @@ -364,7 +364,7 @@ test: script: - pytest -sv --reportportal -m "not command_skip" -n 2 -o "rp_api_key=$RP_DEMO_KEY" tests | tee ./console.log - > - sed -rn 's/Report Portal Launch UUID: ([^\\r\\n]+)/LAUNCH_UUID=\1/ w launch.env' ./console.log + sed -rn 's/ReportPortal Launch UUID: ([^\\r\\n]+)/LAUNCH_UUID=\1/ w launch.env' ./console.log ``` Some explanations here: diff --git a/docs/quality-gates/_category_.json b/docs/quality-gates/_category_.json index fb2eee0b3..49f9db487 100644 --- a/docs/quality-gates/_category_.json +++ b/docs/quality-gates/_category_.json @@ -1,6 +1,6 @@ { "label": "Quality Gates", - "position": "14", + "position": "16", "link": { "type": "generated-index" } diff --git a/docs/releases/Version3.3.2-1.md b/docs/releases/Version3.3.2-1.md new file mode 100644 index 000000000..cd566be8e --- /dev/null +++ b/docs/releases/Version3.3.2-1.md @@ -0,0 +1,13 @@ +--- +sidebar_position: 29 +sidebar_label: Version 3.3.2-1 +--- + +# Version 3.3.2-1 + +**Update instructions** +- In case of update from 3.3.2 version, just update version of API container. +- In case of update from older versions: follow update guide for version 3.3.2 + +**Minor improvements:** +- Backward compatibility with 4.0.x Agents diff --git a/docs/releases/Version3.3.2.md b/docs/releases/Version3.3.2.md new file mode 100644 index 000000000..317637269 --- /dev/null +++ b/docs/releases/Version3.3.2.md @@ -0,0 +1,19 @@ +--- +sidebar_position: 30 +sidebar_label: Version 3.3.2 +--- + +# Version 3.3.2 + +[milestone 3.3](https://github.com/reportportal/reportportal/milestone/5?closed=1) + +[Migrate to version 3.1+ instructions](https://github.com/reportportal/reportportal/wiki/Migration-to-3.1) + + +## Bug fixes + +Fixed the following bugs: + +[#267](https://github.com/reportportal/reportportal/issues/267) Couldn't expand log of test + +[#248](https://github.com/reportportal/reportportal/issues/248) Log message is not expanded if lower than 'level-ERROR' diff --git a/docs/releases/Version4.0.0.md b/docs/releases/Version4.0.0.md new file mode 100644 index 000000000..7c6314511 --- /dev/null +++ b/docs/releases/Version4.0.0.md @@ -0,0 +1,148 @@ +--- +sidebar_position: 28 +sidebar_label: Version 4.0.0 +--- + +# Version 4.0.0 + +Issues and features in [milestone 4.0](https://github.com/reportportal/reportportal/issues?q=is%3Aclosed+milestone%3A4.0) + +## Migration Details + +- MAKE BACKUP + +- IF YOUR MONGO IS INSTALLED ON SEPARATE HOST, WE WOULD LIKE TO DRAW YOUR ATTENTION ON NEW URI FORMAT: RP_MONGO_URI=mongodb://localhost:27017. Please, refer to [MongoDB documentation](https://docs.mongodb.com/manual/reference/connection-string/) to get more details + +- ElasticSearch has been introduced. Please, make sure `vm.max_map_count` kernel setting is defined as it's described in the [official ES guide](https://www.elastic.co/guide/en/elasticsearch/reference/6.1/docker.html#docker-cli-run-prod-mode) to prepare your environment + Please, make sure you give right permissions to ES data folder (as described in the official guide) +```sh +mkdir data/elasticsearch +chmod g+rwx data/elasticsearch +chgrp 1000 data/elasticsearch +``` +- Please, refer to the last version of docker-compose example for more details + +## Agent Compatibility Details +- TestNG: Versions of TestNG framework below 6.10 are not supported +- JVM Clients v3 can be extended to support ReportPortal server v.4. + +## New features + +* New version of Auto Analyzer + +[Ru Video](https://www.youtube.com/watch?v=GsmfLzQdgRs) + +[En Video](https://www.youtube.com/watch?v=d2ekWI2exZ4) + +- [#48](https://github.com/reportportal/reportportal/issues/48) IGNORE flag for AA to skip item next time; +- [#227](https://github.com/reportportal/reportportal/issues/227) Boost human priority; +- A label for auto-analysed test cases (AA) is added; +- An AA action is added to the test cases` history on a Log view; +- Added a filter for test items with a label AA +- Retries and Auto-Analyzer + +* [#37](https://github.com/reportportal/reportportal/issues/37) Flaky test widget +* [#264](https://github.com/reportportal/reportportal/issues/264) Retry + +## Improvements + +### Github Improvements + +* [#254](https://github.com/reportportal/reportportal/issues/254) Added possibility to post bug with a correct link based on Unique ID to test item +* [#238](https://github.com/reportportal/reportportal/issues/238) Added possibility to add a domain without a dot; +* [#230](https://github.com/reportportal/reportportal/issues/230) Escaped logs filter term after refresh +* [#141](https://github.com/reportportal/reportportal/issues/141) Added tags in e-mail body +* [#217](https://github.com/reportportal/reportportal/issues/217) Added possibility to print dashboards (print CSS) +* [#212](https://github.com/reportportal/reportportal/issues/212) Added search for "Add shared widget" window +* [#213](https://github.com/reportportal/reportportal/issues/213) Added possibility to add an own shared widget on an own dashboard +* [#105](https://github.com/reportportal/reportportal/issues/105) Changing a dropdown list on a slider to set a log level +* [#22](https://github.com/reportportal/reportportal/issues/22) Added a filter by a launch number +* [#276](https://github.com/reportportal/reportportal/issues/276) Keep logs and screenshots for a long period of time (forever) +* [#210](https://github.com/reportportal/reportportal/issues/210) Image viewer not close +* [#189](https://github.com/reportportal/reportportal/issues/189) Added feature "Copy result from previous run" +* [#133](https://github.com/reportportal/reportportal/issues/133) ALL DASHBOARDS: Added possibility for List view +* [#250](https://github.com/reportportal/reportportal/issues/250) Support for custom types of defects +* [#136](https://github.com/reportportal/reportportal/issues/136) Added a filter for linked bugs +* [#119](https://github.com/reportportal/reportportal/issues/119) Added test parameters on a Step and Log view +* [#26](https://github.com/reportportal/reportportal/issues/26) LDAPS protocol support +* [#270](https://github.com/reportportal/reportportal/issues/270) Report Portal Email Notification should have "link" configuration +* [#247](https://github.com/reportportal/reportportal/issues/247) Get launch's URL using ReportPortal agent-java-testNG +* [#242](https://github.com/reportportal/reportportal/issues/242) "Replace Comments to All Selected Items" should be checked only after a comment is typed + + +### Widgets Improvements + +**Widgets refactoring:** + +* Launch execution & issue statistics widget refactoring with C3.js library; +* Launch statistics line chart refactoring with C3 library Investigated; percentage of launches refactoring with C3.js library; +* Different launches comparison chart refactoring with C3 library; +* Failed cases trend chart refactoring with C3 library; +* Non-Passed test-cases trend chart with C3 library; +* Test-Cases growth trend chart refactoring with C3 library; +* Launches duration chart refactoring with C3 library; +* Refactor charts for All launches & defect type page & launches table widget with refactoring with C3 library; +* Refactoring of charts on Project Info page; + +**Line chart widget improvements:** + +* Combine line chart and trend chart together; +* Added new zoom functionality on Line chart; +* [#232](https://github.com/reportportal/reportportal/issues/232) Added possibility to combine custom defects type on a Line chart widget; + +**The most failed test cases widget:** + +* Changing a design; +* Changing a mechanism of a results calculating (based on Unique ID); +* Added a name of chosen defect type on a widget view; + +**Other widget improvements:** + +[#174](https://github.com/reportportal/reportportal/issues/174) Widget silent update (save an actions with a legend after an auto-refresh); +Added test parameters separately from description; + + +### Improvements on ReportPortal + +* Added Cheat Sheets to the documentation on ReportPortal (“Installation steps”); +* Added possibility to correct and improve documentation on reportportal.io by our Users; +* Added twitter widget; +* Added YouTube widget; +* Added a collapsing function for a documentation menu; +* Added new section for easy downloading ["Download"](http://reportportal.io/download) +* Added Docker-compose.yml generator +* Added extended scheme of agents` working + +### Minor Improvements + +* History table is grouping test items by Unique ID; +* Added ALL to multie drop-down list; +* Added clickable elements on Management board +* Remove match issue +* Added mechanism based on UID to Merge functionality +* Added"check All" to dropdown lists; + + +## Bug fixes + +### Bugs + +* [#249](https://github.com/reportportal/reportportal/issues/249) Notification rule for launch in Debug +* [#4](https://github.com/reportportal/plugin-jenkins/issues/4) Correct a link on Jenkins plugin +* [#268](https://github.com/reportportal/reportportal/issues/268) Warning about an outdated browser +* [#218](https://github.com/reportportal/reportportal/issues/218) system-out is not recognized when importing junit +* [#255](https://github.com/reportportal/reportportal/issues/255) Invalid link for the test in the "FOUND IN" column +* [#322](https://github.com/reportportal/reportportal/issues/322) Make startTestItemRQ in API 4.x case insensitive +* [#317](https://github.com/reportportal/reportportal/issues/317) Bad request. The importing file has invalid format. 'There are invalid xml files inside. +* [#314](https://github.com/reportportal/reportportal/issues/314) Set up different "superadmin" password +* [#307](https://github.com/reportportal/reportportal/issues/307) Cucumber Java Agent – Steps are sporadically missing from the test’s logs +* [#305](https://github.com/reportportal/reportportal/issues/305) JBehave NPE if givenStory=true for root story +* [#281](https://github.com/reportportal/reportportal/issues/281) system-out is not recognized when importing junit +* [#188](https://github.com/reportportal/reportportal/issues/188) Error Message: Start time of child ['Wed Jul 19 12:53:49 UTC 2017'] item should be same or later than start time ['Wed Jul 19 12:53:49 UTC 2017'] of the parent item/launch '596f565d2ab79c0007b48b46' Error Type: CHILD_START_TIME_EARLIER_THAN_PARENT + + +### Agent bugs + +* [#220](https://github.com/reportportal/reportportal/issues/220) Cucumber-JVM: RP throws exception, when there is no features match the filter +* [#229](https://github.com/reportportal/reportportal/issues/229) Unable to view logs for some test items +* [#3](https://github.com/reportportal/logger-java-log4j/issues/3) Race condition failures: lost logs and failures diff --git a/docs/releases/Version4.1.0.md b/docs/releases/Version4.1.0.md new file mode 100644 index 000000000..3834bfbfe --- /dev/null +++ b/docs/releases/Version4.1.0.md @@ -0,0 +1,16 @@ +--- +sidebar_position: 27 +sidebar_label: Version 4.1.0 +--- + +# Version 4.1.0 + +Issues and features in milestone 4.1 + +## Improvements + +* [#369](https://github.com/reportportal/reportportal/issues/369) Custom rules for Auto-Analysis: AA based on launches with the same name and on all launches on a project +* [#66](https://github.com/reportportal/reportportal/issues/66) JIRA & RALLY: possibility to select issue type +* [#106](https://github.com/reportportal/reportportal/pull/106) Replace enum with simple string for better bts extension +* Parameter "rp.project" should have the current project as a value and not the default_project +* MERGE: Possibility to merge launches by specifying only launch ID and merge type via APIrequest diff --git a/docs/releases/Version4.2.0.md b/docs/releases/Version4.2.0.md new file mode 100644 index 000000000..a3993dfe5 --- /dev/null +++ b/docs/releases/Version4.2.0.md @@ -0,0 +1,40 @@ +--- +sidebar_position: 26 +sidebar_label: Version 4.2.0 +--- + +# Version 4.2.0 + +## Features + +* [#417](https://github.com/reportportal/reportportal/issues/417) Segregation of AA settings in a separate section +* [#417](https://github.com/reportportal/reportportal/issues/417) Added a possibility to configure ML; +* [#417](https://github.com/reportportal/reportportal/issues/417) Added a possibility to remove/generate ElasticSearch index (ML education); +* [#381](https://github.com/reportportal/reportportal/issues/381) Auto-Analysis: AA for the current launch (analogue of our previous feature "Match issue); +* [#382](https://github.com/reportportal/reportportal/issues/382) Auto-Analysis: Possibility to chose which items should be auto-analysed in the launch ( With "To investigate", Already auto-analysed, analysed manually) ; + *Documentation about auto-analysis is [here](/analysis/AutoAnalysisOfLaunches)* +* [#366](https://github.com/reportportal/reportportal/issues/366) Bulk operation for Unlink issues in BTS; + +## Improvements +* [#103](https://github.com/reportportal/reportportal/issues/103) HAR viewer for attached .har files; +* [#326](https://github.com/reportportal/reportportal/issues/326) Clickable launch number on a history line; +* [#328](https://github.com/reportportal/reportportal/issues/328) Clickable History table; +* [#329](https://github.com/reportportal/reportportal/issues/329) Duration in format MM:SS +* [#384](https://github.com/reportportal/reportportal/issues/384) [#613](https://github.com/reportportal/service-ui/issues/613) Option for "Tag" filter - "Not contain" +* [#339](https://github.com/reportportal/reportportal/issues/339) OAuth App on GitHub requires the user scope instead of read:user +* "Load issue" has been renamed to "Link issue" +* Added infinite session in full-screen mode(for using ReportPortal dashboards on screens) + +:::note +Before using the last function, please visit Profile page for the auto-generation of API token. +::: +## Bugs +* [#374](https://github.com/reportportal/reportportal/issues/374) Logs with level Error (40 000) and higher are considered in ElasticSearch +* [#376](https://github.com/reportportal/reportportal/issues/376) Unnecessary logging of all items in the run in case if run cannot be completed +* [#371](https://github.com/reportportal/reportportal/issues/371) Unable to connect ldap +* [#251](https://github.com/reportportal/reportportal/issues/251) Internal Server Error if no external system id is specified +* [#292](https://github.com/reportportal/reportportal/issues/292) Embedded cucumber log attachments are displayed incorrectly via reportportal +* [#380](https://github.com/reportportal/reportportal/issues/380) Issue with retry: negative statistics [#380](https://github.com/reportportal/reportportal/issues/380) +* Fixed bug with disappearing numbers on mobile version of All launches + +All issues and features are in milestone 4.2 diff --git a/docs/releases/Version4.3.md b/docs/releases/Version4.3.md new file mode 100644 index 000000000..3429c2e34 --- /dev/null +++ b/docs/releases/Version4.3.md @@ -0,0 +1,27 @@ +--- +sidebar_position: 25 +sidebar_label: Version 4.3 +--- + +# Version 4.2.0 + +## Features + + +* [#442](https://github.com/reportportal/reportportal/issues/442) Added a link to the test item which have been used by Analyzer for decision on History of Actions (Log view); + +* Previous Analyzer is back (choose pre-set Classic) + +## Improvements + +* [#452](https://github.com/reportportal/reportportal/issues/452) Added possibility to share with a quick filter on All launches by link; +* [#427](https://github.com/reportportal/reportportal/issues/427) Allowed to set autoAnalyzed flag via API; +* [#375](https://github.com/reportportal/reportportal/issues/375) Added option *with/without methods* to Most failed/ flaky tests cases widgets; +* Performance optimization for Latest Launches; + +## Bugs + +* [#440](https://github.com/reportportal/reportportal/issues/440) Not getting any data on widget when selecting Start Time in filter +* [#436](https://github.com/reportportal/reportportal/issues/436) Jira integration: Bug priority is always `Minor` + +All issues and features are in milestone [4.3](https://github.com/reportportal/reportportal/milestone/21?closed=1) diff --git a/docs/releases/Version5.0.0.md b/docs/releases/Version5.0.0.md new file mode 100644 index 000000000..bf4917fc2 --- /dev/null +++ b/docs/releases/Version5.0.0.md @@ -0,0 +1,93 @@ +--- +sidebar_position: 23 +sidebar_label: Version 5.0.0 +--- + +# Version 5.0.0 + +Finally we are glad to introduce a new release of ReportPortal. +In this version we have: + +* Migrated to PostgreSQL +* Migrated to React JS +* Removed Consul +* Introduced RabbitMQ for asynchronous reporting\ +* Introduced a plugin system +* Improved performance x3 + +## Installation details +- [with Docker](/installation-steps/DeployWithDockerOnLinuxMac) +- [with Kubernetes Helm chart](/installation-steps/DeployWithKubernetes) #362 +- Manual set up [without Docker](/installation-steps/DeployWithoutDocker) +- [**v4 -> v5 data migration instruction**](https://github.com/reportportal/reportportal/wiki/Migration-to-ReportPortal-v.5) +## Plugins +Jira, Rally, SauceLabs integration now will work through the plugin functionality. You need to download latest JAR package from our Bintray repository, and drag-n-drop it ReportPortal in Administrative section -> Plugins. + +Read more [here](/plugins/ManagePlugins#upload-plugin). + +Available plugins to download: +- [Jira](/plugins/AtlassianJiraServer) +- [Rally](/plugins/Rally) +- [SauceLabs](/plugins/SauceLabs) +## Brand new features +- [#275](https://github.com/reportportal/reportportal/issues/275) [#639](https://github.com/reportportal/reportportal/issues/639) Nested steps +- [#348](https://github.com/reportportal/reportportal/issues/348) Integration with SauceLabs +- [#673](https://github.com/reportportal/reportportal/issues/673) [#486](https://github.com/reportportal/reportportal/issues/486) Pattern analysis +- [#675](https://github.com/reportportal/reportportal/issues/675) Auto-updated wWidget based on launch attributes (Cumulative trend chart, Component Health Check) +- 15 sub-defects per defect type +- [#41](https://github.com/reportportal/reportportal/issues/41) Sub-defects for “To investigate” +- Replace tags with attributes (attributes = key:value) +- [#680](https://github.com/reportportal/reportportal/issues/680) Implement a plugin system for integration with external systems (JIRA, Rally, SauceLabs, E-mail server) +- A possibility to change status of test item +- A view with a test item s list from different launch (Clickable area for Overall statistics, Component Health Check widget) + +## Reporting updates +- Reduced restriction for synchronous reporting +- Fully asynchronous reporting with `api/v2` +- [#275](https://github.com/reportportal/reportportal/issues/275) [#639](https://github.com/reportportal/reportportal/issues/639) Reporting with Nested steps (see section Agents Updates) +- [#526](https://github.com/reportportal/reportportal/issues/526) [#444](https://github.com/reportportal/reportportal/issues/444) Logs/attachments for launch level (see section Agents Updates) +- [#571](https://github.com/reportportal/reportportal/issues/571) [#451](https://github.com/reportportal/reportportal/issues/451) Finish launch with populated status +- [#670](https://github.com/reportportal/reportportal/issues/670) Interruption children “in progress” when a parent has been finished +- [#671](https://github.com/reportportal/reportportal/issues/671) [#548](https://github.com/reportportal/reportportal/issues/548) Reporting test code reference (see section Agents Updates) +- [#490](https://github.com/reportportal/reportportal/issues/490) Reporting test into finished Parent Item +- A possibility to report tests with Test Case ID (ID number from your test management system) + +## Small and nice updates +- [#453](https://github.com/reportportal/reportportal/issues/453) Launch description and attributes on the suite view +- [#606](https://github.com/reportportal/reportportal/issues/606) Markdown on the Log page (no need in !!!MARKDOWN MODE!!!) +- Possibility to configure integrations (Jira/Rally/ E-mail-server/ SauceLabs) per project and for the whole instance +- [#618](https://github.com/reportportal/reportportal/issues/618) Increase limitation for step name length from 256 to 1024 +- [#457](https://github.com/reportportal/reportportal/issues/457) Increase password length +- Auto launch deleting +- Increase the number of launches for widgets from 150 to 600 + + +## Bug fixing +- [#522](https://github.com/reportportal/reportportal/issues/522) Defect comment is not updated during deleting +- [#542](https://github.com/reportportal/reportportal/issues/542) Issue with History line +- [#542](https://github.com/reportportal/reportportal/issues/542) Unable to create a link to the result log page - page keeps reloading +- [#563](https://github.com/reportportal/reportportal/issues/563) DOM XSS in rp.epam.com +- [#564](https://github.com/reportportal/reportportal/issues/564) There is no possibility to enter login/password for email settings with RU local + +## Administrative page updates +- New design +- Possibility to filter projects and users +- Plugin system +- [#364](https://github.com/reportportal/reportportal/issues/364) Possibility to delete personal projects + +## Agents update +- Reporting with Nested steps (already updated TestNG) +- Logs/attachments for launch level (already updated TestNG) +- Reporting test code reference (already updated Java-based agents) +- Reporting test case ID (already updated Java-based agents) + +## Test frameworks integration +- The majority of test framework integrations (agents) of v4 supported by ReportPortal v5.0 backward compatibility. But do not use latest features, capabilities and performance upgrades (NestedSteps, Re-run, re-tries, etc.) +- Please take latest agents started with `5.*` in order to get full support of RPv5 features (work in progress, agents will be released soon) + +## Dev guides +- [ReportPortal with APIv5](https://github.com/reportportal/documentation/blob/master/src/md/src/DevGuides/reporting.md) +- [API v5 vs v4 difference](https://github.com/reportportal/documentation/blob/master/src/md/src/DevGuides/api-differences.md) +- [Using Re-Run functionality for Launches](https://github.com/reportportal/documentation/blob/master/src/md/src/DevGuides/rerun.md) +- [Using Re-Run functionality for Launches](https://github.com/reportportal/documentation/blob/master/src/md/src/DevGuides/rerun.md) +- [Interaction with Analyzer](https://github.com/reportportal/documentation/blob/master/src/md/src/DevGuides/analyzer.md) diff --git a/docs/releases/Version5.0RC.md b/docs/releases/Version5.0RC.md new file mode 100644 index 000000000..2bafeffc7 --- /dev/null +++ b/docs/releases/Version5.0RC.md @@ -0,0 +1,66 @@ +--- +sidebar_position: 24 +sidebar_label: Version 5.0RC +--- + +# Version 5.0RC + +This is the Beta release. + +## Brand new features +- [#275](https://github.com/reportportal/reportportal/issues/275) [#639](https://github.com/reportportal/reportportal/issues/639) Nested steps +- [#348](https://github.com/reportportal/reportportal/issues/348) Integration with SauceLabs +- [#673](https://github.com/reportportal/reportportal/issues/673) [#486](https://github.com/reportportal/reportportal/issues/486) Pattern analysis +- [#675](https://github.com/reportportal/reportportal/issues/675) Widget based on launch attributes (Cumulative trend chart) +- 15 sub-defects per defect type +- [#41](https://github.com/reportportal/reportportal/issues/41) Sub-defects for “To investigate” +- Replace tags with attributes (attributes = key:value) +- [#680](https://github.com/reportportal/reportportal/issues/680) Implement a plugin system for integration with external systems (JIRA, Rally, SauceLabs, E-mail server) + +## Reporting updates +- Reduced restriction for synchronous reporting (beta) +- Fully asynchronous reporting (beta) +- [#275](https://github.com/reportportal/reportportal/issues/275) [#639](https://github.com/reportportal/reportportal/issues/639) Reporting with Nested steps (see section Agents Updates) +- [#526](https://github.com/reportportal/reportportal/issues/526) [#444](https://github.com/reportportal/reportportal/issues/444) Logs/attachments for launch level (see section Agents Updates) +- [#571](https://github.com/reportportal/reportportal/issues/571) [#451](https://github.com/reportportal/reportportal/issues/451) Finish launch with populated status +- [#670](https://github.com/reportportal/reportportal/issues/670) Interruption children “in progress” when a parent has been finished +- [#671](https://github.com/reportportal/reportportal/issues/671) [#548](https://github.com/reportportal/reportportal/issues/548) Reporting test code reference (see section Agents Updates) +- [#490](https://github.com/reportportal/reportportal/issues/490) Reporting test into finished Parent Item + +## Small and nice updates +- [#453](https://github.com/reportportal/reportportal/issues/453) Launch description and attributes on the suite view +- [#606](https://github.com/reportportal/reportportal/issues/606) Markdown on the Log page +- Possibility to configure integrations (Jira/Rally/ E-mail-server/ SauceLabs) per project and for the whole instance +- [#618](https://github.com/reportportal/reportportal/issues/618) Increase limitation for step name length from 256 to 1024 +- [#457](https://github.com/reportportal/reportportal/issues/457) Increase password length +- Auto launch deleting +- Increase the number of launches for widgets + + +## Bug fixing +- [#522](https://github.com/reportportal/reportportal/issues/522) Defect comment is not updated during deleting +- [#542](https://github.com/reportportal/reportportal/issues/542) Issue with History line +- [#542](https://github.com/reportportal/reportportal/issues/542) Unable to create a link to the result log page - page keeps reloading +- [#563](https://github.com/reportportal/reportportal/issues/563) DOM XSS in rp.epam.com +- [#564](https://github.com/reportportal/reportportal/issues/564) (BUG) There is no possibility to enter login/password for email settings with RU local + +## Administrative page updates +- New design +- Possibility to filter projects and users +- Plugin system +- [#364](https://github.com/reportportal/reportportal/issues/364) Possibility to delete personal projects + +## Agents update +- Reporting with Nested steps (already updated TestNG) +- Logs/attachments for launch level (already updated TestNG) +- Reporting test code reference (already updated Java-based agents) + +## Integration with Java Test Frameworks +- [Java TestNG](/log-data-in-reportportal/test-framework-integration/Java/TestNG) +- [JUnit](/log-data-in-reportportal/test-framework-integration/Java/JUnit4) +- [JUNit5](/log-data-in-reportportal/test-framework-integration/Java/JUnit5) +- [Cucumber](/log-data-in-reportportal/test-framework-integration/Java/Cucumber) +- [Jbehave](/log-data-in-reportportal/test-framework-integration/Java/JBehave) + +## Dev guides +- [How to report results to ReportPortal](https://github.com/ihar-kahadouski/dev-guide/blob/master/reporting.md) diff --git a/docs/releases/Version5.1.0.md b/docs/releases/Version5.1.0.md new file mode 100644 index 000000000..ec546d9af --- /dev/null +++ b/docs/releases/Version5.1.0.md @@ -0,0 +1,53 @@ +--- +sidebar_position: 22 +sidebar_label: Version 5.1.0 +--- + +# Version 5.1.0 + +>**Important**: We are constantly improving ReportPortal. And in version 5.1 we have changed a way we encrypt your personal data. Please be aware, that for successful interaction with version 5.1 you need to change a password at the first login. +> **Please read instructions below**. +> +> Thank you for being with us, ReportPortal team + +## Brand new features +- [#893](https://github.com/reportportal/reportportal/issues/893) Improved ML in Аuto-Autoanalysis 2.0 +- [#894](https://github.com/reportportal/reportportal/issues/894) History line improvements +- [#896](https://github.com/reportportal/reportportal/issues/896) History table for the whole Launch/Filter +- [#899](https://github.com/reportportal/reportportal/issues/899) Possibility to compare results from: Launch/Launch; Launch/Filter; Filter/Filter +- Java 11 introduced + +## Reporting updates +- [#895](https://github.com/reportportal/reportportal/issues/895) Explicit declaration of Test Case ID: Possibility to report execution with Test Case ID from your Test Case Management system + +## Small and nice updates +- [#586](https://github.com/reportportal/reportportal/issues/586) Clickable area for widgets: + * Overall statistics bar view + * Failed case trend chart + * Non-passed test cases trend chart + * Passing rate per filter + * Cumulative trend chart + * Most popular pattern table (TOP-20) +- Added a launch UUID in the modal "Edit Launch" +- Added a possibility to resize the Cumulative trend chart widget. +- Refactored auto-complete component +- Introduced Java 11 for API +- [#744](https://github.com/reportportal/reportportal/issues/744) Migrated to Traefik 2 + +## Bug fixing + +- Added a considering of nested steps logs in an auto-analysis procedure +- [#741](https://github.com/reportportal/reportportal/issues/741) Added a possibility to collapse/expand additional launch info on Launches Table widget. +- [#870](https://github.com/reportportal/reportportal/issues/870) Fixed a possibility to send link to BTS on an item finish +- [#447](https://github.com/reportportal/reportportal/issues/447) Fixed launch inactivity scripts +- Fixed launch/attachments/screenshots deleting scripts +- [#746](https://github.com/reportportal/reportportal/issues/746) Backward compatibilities for !!!MARKDOWN!!! in logs +- [#768](https://github.com/reportportal/reportportal/issues/768) Added markdown support for video links in logs +- [#740](https://github.com/reportportal/reportportal/issues/740) Fixed a possibility to view a full launch name in widgets tooltips +- [#749](https://github.com/reportportal/reportportal/issues/749) Fixed a scroll in full-screen mode for widgets + +## Known issues +LDAP returns Code 500 when the integration configuration is not correct + +## How to migrate to the latest version 5.1 +Details can be found [here](https://github.com/reportportal/reportportal/wiki/Migration-to-ReportPortal-v.5.1) diff --git a/docs/releases/Version5.2.0.md b/docs/releases/Version5.2.0.md new file mode 100644 index 000000000..e136588ca --- /dev/null +++ b/docs/releases/Version5.2.0.md @@ -0,0 +1,18 @@ +--- +sidebar_position: 21 +sidebar_label: Version 5.2.0 +--- + +# Version 5.2.0 + +## Small and nice updates +- Expanded the list of possible statuses for Nested Steps (Passes, Failed, Skipped, Warn, Info) +- Nested steps names support Markdown on the Log view +- Added retry handling on the finish +- Added Test Case ID handling on the finish +## Bug fixing +- [#117](https://github.com/reportportal/reportportal/issues/117) Fixed a bug with SauceLabs video +- Fixed a bug with mp4 and webm files downloading +- Fixed bug with IE (ReportPortal didn`t open in IE) + + diff --git a/docs/releases/Version5.2.1.md b/docs/releases/Version5.2.1.md new file mode 100644 index 000000000..483530812 --- /dev/null +++ b/docs/releases/Version5.2.1.md @@ -0,0 +1,8 @@ +--- +sidebar_position: 20 +sidebar_label: Version 5.2.1 +--- + +# Version 5.2.1 + +Fix reportportal/kubernetes [#115](https://github.com/reportportal/reportportal/issues/115) diff --git a/docs/releases/Version5.2.2.md b/docs/releases/Version5.2.2.md new file mode 100644 index 000000000..5a5b46392 --- /dev/null +++ b/docs/releases/Version5.2.2.md @@ -0,0 +1,15 @@ +--- +sidebar_position: 19 +sidebar_label: Version 5.2.2 +--- + +# Version 5.2.2 + +## Improvements + +Added [a possibility to choose a base for a History table via a docker-compose](/work-with-reports/HistoryOfLaunches#historical-trend-of-executions) + +## Bugs +[#997](https://github.com/reportportal/reportportal/issues/997) History doesn't compatible after data migration from v4 to v5 +Auto-Analysis analyzes logs in nested steps +Pattern Analysis analyzes logs in nested steps diff --git a/docs/releases/Version5.2.3.md b/docs/releases/Version5.2.3.md new file mode 100644 index 000000000..159e4bf26 --- /dev/null +++ b/docs/releases/Version5.2.3.md @@ -0,0 +1,11 @@ +--- +sidebar_position: 18 +sidebar_label: Version 5.2.3 +--- + +# Version 5.2.3 + +## Bugs +[#950](https://github.com/reportportal/reportportal/issues/950) Service API PostgreSQL DB locks on SELECT queries +Performance improvements +Small UI fixes diff --git a/docs/releases/Version5.3.0.md b/docs/releases/Version5.3.0.md new file mode 100644 index 000000000..f157818fc --- /dev/null +++ b/docs/releases/Version5.3.0.md @@ -0,0 +1,30 @@ +--- +sidebar_position: 17 +sidebar_label: Version 5.3.0 +--- + +# Version 5.3.0 + +## Brand new features + +[#269](https://github.com/reportportal/reportportal/issues/269) Component Health Check Widget (table view) +[#877](https://github.com/reportportal/reportportal/issues/877) SAML auth + + +## Small and nice updates + +- Filter by retried items on step level view +- Purging jobs delete logs/attachments/launches by star time, not lastModified time +- [#1005](https://github.com/reportportal/reportportal/issues/1005) Auto-Analysis: Add a boost for items with the latest Defect Type +- Parent line recalculation on the step view +- Refine on the Step view: Has retries / Hasn`t retries +- Filter description is increased to 1500 + + +## Bug fixing + +- Github login does not work for users with private membership in the organization +- [#773](https://github.com/reportportal/reportportal/issues/773) Service-API errors when the user does not have a photo +- Wrong order during retry reporting +- Reduced number of requests to BTS +- Performance fixes diff --git a/docs/releases/Version5.3.1..md b/docs/releases/Version5.3.1..md new file mode 100644 index 000000000..917d8c501 --- /dev/null +++ b/docs/releases/Version5.3.1..md @@ -0,0 +1,16 @@ +--- +sidebar_position: 16 +sidebar_label: Version 5.3.1 +--- + +# Version 5.3.1 + +## Bug fixing + +[Performance]High CPU and Disk IO utilization of PostgreSQL queries + +[Performance] Responce time degradation of the History Table on Steps Level due to high cpu utilization of the DB query + +[Performance][PreProd] High responce time(up to 3 min) of the Most Failed TC Widget loading + +Fix for launches purging job diff --git a/docs/releases/Version5.3.2.md b/docs/releases/Version5.3.2.md new file mode 100644 index 000000000..bb600a63e --- /dev/null +++ b/docs/releases/Version5.3.2.md @@ -0,0 +1,13 @@ +--- +sidebar_position: 15 +sidebar_label: Version 5.3.2 +--- + +# Version 5.3.2 + +## Bug fixing + +* The high amount of DB locks on the UPDATE public.users query +* Unclassified error when Admin creates shared widget based on not shared filter +* High Disk utilization of PostgreSQL queries generated by Component Health Check Widget(table view) +* Bug with Component Health Check Widget(table view) diff --git a/docs/releases/Version5.3.3.md b/docs/releases/Version5.3.3.md new file mode 100644 index 000000000..bef204dcd --- /dev/null +++ b/docs/releases/Version5.3.3.md @@ -0,0 +1,38 @@ +--- +sidebar_position: 14 +sidebar_label: Version 5.3.3 +--- + +# Version 5.3.3 + +## New features + +- Increased number of launches for Cumulative trend chart from 600 to 10 000 launches + +## Small and nice updates + +- Added expanded failed items by default. Improved an alignment of arrows and step names on Log view +- Launches. Log view. Attachment section. Gallery improvement for reducing the number of clicks +- Added a possibility to add attributes to refine rather than replace them +- [UI] Show first 5 lines for defect comment instead of 2 first lines on Step view and on Log view +- Increased a description for widgets/dashboards/filters to 1500 symbols + +## Analyzer improvements +- Analyzer. Add more options for log lines in settings +- Added a boosting feature for the similarity between log lines with more important namespaces + +## Bugfixing +- Fixed: [#867](https://github.com/reportportal/reportportal/issues/867) Very poor scroll performance +- Fixed: [#1128](https://github.com/reportportal/reportportal/issues/1128) Wrong password in the email letter when adding a new user +- Fixed: [#1182](https://github.com/reportportal/reportportal/issues/1182) Year in footer copyright text is not up to date +- Fixed [#857](https://github.com/reportportal/reportportal/issues/857) Total Failed count is not matched with Test cases after Merging the multiple Launches [ deep merge] +- Fixed: [#911](https://github.com/reportportal/reportportal/issues/911) Widget table column width (Unique bugs table) +- Fixed: [#871](https://github.com/reportportal/reportportal/issues/871) Launch duration chart label "seconds" +- Fixed: [#1050](https://github.com/reportportal/reportportal/issues/1050) Add UUID data to TestItem Controller when querying using filters +- Fixed: [#1184](https://github.com/reportportal/reportportal/issues/1184) No history of test-items with defect +- Fixed: History. Compare functionality. The custom column has items from 1st execution instead of the latest one +- Fixed: 'Add new widget' from Launches page in case no dashboards on the project +- Fixed: Only one attribute is returned for the launches in 'Launches table' widget +- Fixed: Only the first 12 attachments are displayed in 'Attachments' section +- [Performance] Issue with DB CPU utilization of "Flaky" widget query +- Fixed unclassified errors from inserts of issues for failed items diff --git a/docs/releases/Version5.3.5.md b/docs/releases/Version5.3.5.md new file mode 100644 index 000000000..248a9c64d --- /dev/null +++ b/docs/releases/Version5.3.5.md @@ -0,0 +1,11 @@ +--- +sidebar_position: 13 +sidebar_label: Version 5.3.5 +--- + +# Version 5.3.5 + +# Bugfixing +- Fixed: [#950](https://github.com/reportportal/reportportal/issues/950) Problems with DB locks on SELECT +- Fixed: [#1231](https://github.com/reportportal/reportportal/issues/1231) Problems with data retention jobs +- Fixed: [#1269](https://github.com/reportportal/reportportal/issues/1269) Problem with an infinite load on Ctrl/Command+Click diff --git a/docs/releases/Version5.4.0.md b/docs/releases/Version5.4.0.md new file mode 100644 index 000000000..374048576 --- /dev/null +++ b/docs/releases/Version5.4.0.md @@ -0,0 +1,28 @@ +--- +sidebar_position: 12 +sidebar_label: Version 5.4.0 +--- + +# Version 5.4.0 + +[Migration guide](https://github.com/reportportal/reportportal/wiki/Migration-to-ReportPortal-v.5.4) + +## New features +- [#1440](https://github.com/reportportal/reportportal/issues/1440) Data retention jobs refactoring +- Top-20 most time-consuming tests widget +- 30 executions on the History line +- Launch attributes on History Line and History table +- Filter by Jira issue ID +- URL by launch UUID +- Design updates + +## Analyzer updates +[#1363](https://github.com/reportportal/reportportal/issues/1363) ML-based analyzer improvements + +## Small and nice update +- Increased description filter from 16 to 256 +- Improvement for AD plugin. Active directory dynamic user search filter +- Added clickable area to Passing rate + +## Bugfixing +- Fixed: Issue with deadlocks diff --git a/docs/releases/Version5.5.0.md b/docs/releases/Version5.5.0.md new file mode 100644 index 000000000..57cbd3edb --- /dev/null +++ b/docs/releases/Version5.5.0.md @@ -0,0 +1,23 @@ +--- +sidebar_position: 11 +sidebar_label: Version 5.5.0 +--- + +# Version 5.5.0 + +[Migration guide](https://github.com/reportportal/reportportal/wiki/Migration-to-ReportPortal-v.5.5) + +## New features +- Make decision modal + +## Analyzer updates +- ML suggestions in Make decision modal +- Add logic for auto-analysis for No defect test items + +## Small and nice update +- Performance improvements + +## Bugfixing +- Fixed: [Performance] CPU utilization degradation of select child items on different levels +- Fixed: bugs with rerun functionality + diff --git a/docs/releases/Version5.6.0.md b/docs/releases/Version5.6.0.md new file mode 100644 index 000000000..2b3894a34 --- /dev/null +++ b/docs/releases/Version5.6.0.md @@ -0,0 +1,41 @@ +--- +sidebar_position: 10 +sidebar_label: Version 5.6.0 +--- + +# Version 5.6.0 + +[Migration guide](https://github.com/reportportal/reportportal/wiki/Migration-to-ReportPortal-v.5.6) + +## New features +- [#1094](https://github.com/reportportal/reportportal/issues/1094) Filter by Attributes + +## Small and nice update +- Change status from the Log View +- Add Test Case ID to the log view + +## Analyzer updates +- Cleaning Job for Elastic Search +- "All big log messages should match +- Add the to investigate group except To Investigate itself to be used in Auto-analysis and suggestions +- Add a field with test item name while indexing logs/auto-analysis/suggestions +- Add configuration to check strictly all log message while analysis +- When demo data is generated, the user should click "generating index" for analyzer himself +- Adding launch name/message info into custom retrained models +- Add checking by Exceptions and releasing the min should match for search/cluster operations to 95% +- Add checking by Exceptions and releasing the min should match for search/cluster operations to 95% +- Adding launch name/message info into custom retrained models +- Changed the logic for No defect and custom TI defect types for auto-analysis +- Create a similar for searching by similar TI items as for AA logic for treating short/long messages +- The users complained that some older test items still can be used by Auto-analysis, so I decided to add discounting for the ES scores in case they are farther from the start_time of the test item. + +## Bugfixing +- Performance fixes +- Fixed issue with deadlocks by retries refactoring +- [#1474](https://github.com/reportportal/reportportal/issues/1474) SAML. Add "callbackUrl" field to SAML configuration +- Failed cases trend chart. Send only "statistics$executions$failed" field in "contentFields" +- [#1502](https://github.com/reportportal/reportportal/issues/1502) Email configurations. Change field "Username" to "Sender email" + +## What's Changed +* Release 5.6.0 by @Cyberglamdring [in #1583](https://github.com/reportportal/reportportal/pull/1583) +* [Full Changelog](https://github.com/reportportal/reportportal/compare/5.5.0...5.6.0) diff --git a/docs/releases/Version5.6.1.md b/docs/releases/Version5.6.1.md new file mode 100644 index 000000000..8972b3296 --- /dev/null +++ b/docs/releases/Version5.6.1.md @@ -0,0 +1,9 @@ +--- +sidebar_position: 9 +sidebar_label: Version 5.6.1 +--- + +# Version 5.6.1 + +## Bugfixing +- Fixed Log4J vulnerabilities [CVE-2021-44228](https://github.com/advisories/GHSA-jfh8-c2jp-5v3q), [CVE-2021-45046](https://github.com/advisories/GHSA-7rjr-3q55-vv33): bumping the dependency version to the `2.16.0` diff --git a/docs/releases/Version5.6.2.md b/docs/releases/Version5.6.2.md new file mode 100644 index 000000000..2cc98e5bb --- /dev/null +++ b/docs/releases/Version5.6.2.md @@ -0,0 +1,10 @@ +--- +sidebar_position: 8 +sidebar_label: Version 5.6.2 +--- + +# Version 5.6.2 + +# Bugfixing + +- ReportPortal release 5.6.2 aimed at fixing Log4J vulnerabilities: [CVE-2021-44228](https://github.com/advisories/GHSA-jfh8-c2jp-5v3q), [CVE-2021-45046](https://github.com/advisories/GHSA-7rjr-3q55-vv33) and [CVE-2021-45105](https://github.com/advisories/GHSA-p6xc-xr62-6r2g) diff --git a/docs/releases/Version5.6.3.md b/docs/releases/Version5.6.3.md new file mode 100644 index 000000000..dbae2e557 --- /dev/null +++ b/docs/releases/Version5.6.3.md @@ -0,0 +1,9 @@ +--- +sidebar_position: 7 +sidebar_label: Version 5.6.3 +--- + +# Version 5.6.3 + +## Bugfixing +- Log4J vulnerabilities: [CVE-2021-44832](https://github.com/advisories/GHSA-8489-44mv-ggj8) diff --git a/docs/releases/Version5.7.0.md b/docs/releases/Version5.7.0.md new file mode 100644 index 000000000..12258cfb3 --- /dev/null +++ b/docs/releases/Version5.7.0.md @@ -0,0 +1,38 @@ +--- +sidebar_position: 6 +sidebar_label: Version 5.7.0 +--- + +# Version 5.7.0 + +## New Features: +A possibility to see all unique errors for a launch +[#1268](https://github.com/reportportal/reportportal/issues/1268). Support of Azure SAML authorization + + +## New Plugins: + +- [Jira Cloud](https://github.com/reportportal/plugin-bts-jira-cloud/packages/1366483) plugin for posting new bugs +- [Azure DevOps](https://github.com/reportportal/plugin-bts-azure/packages/1366495) plugin for posting new bugs + +## Small and Nice Updates: + +- New design for Make decision modal +- Help & Support functionality for newly deployed instances +- Additional configuration for Similar “To Investigate” functionality (“Min Should Match”) +- Default State for Auto-Analysis is ON + +## Bugfixing: + +- New logic for removing widget has been implemented (deleting a parent widget doesn’t delete the child widget) +- [#1603](https://github.com/reportportal/reportportal/issues/1603). Attributes. Error on cancel edit common attributes in "Edit items" modal +- [#1181](https://github.com/reportportal/reportportal/issues/1181). Most Failed Tests and Most Flaky Tests widgets: wrong time is shown +- [#1606](https://github.com/reportportal/reportportal/issues/1606). Component Health Check Widget not working after Upgrade +- [#1616](https://github.com/reportportal/reportportal/issues/1616). Component health check (table view) widget for HotProd filter does not load results and keeps spinning + + +## Performance Improvements: + +- 3x improved performance of project index generation for Auto-Analysis +- Refactored and optimized retry items processing +- Increased Auto-Analysis performance by updating the communicating interface between API and ANALYZERS diff --git a/docs/releases/Version5.7.1.md b/docs/releases/Version5.7.1.md new file mode 100644 index 000000000..f1b70ee56 --- /dev/null +++ b/docs/releases/Version5.7.1.md @@ -0,0 +1,9 @@ +--- +sidebar_position: 5 +sidebar_label: Version 5.7.1 +--- + +# Version 5.7.1 + +## Technical Improvements: +Functionality to configure virtual hosts in RabbitMQ for Analyzer was added diff --git a/docs/releases/Version5.7.2.md b/docs/releases/Version5.7.2.md new file mode 100644 index 000000000..57ca6ba35 --- /dev/null +++ b/docs/releases/Version5.7.2.md @@ -0,0 +1,51 @@ +--- +sidebar_position: 4 +sidebar_label: Version 5.7.2 +--- + +# Version 5.7.2 + +## What's Changed: + +ReportPortal Release 5.7.2 aimed on enabling log messages to be saved into ElasticSearch +- We now save logs into 2 sources: DB and Elastic (via DataStreams) + +## New features +- A possibility to see all unique errors for a launch (click the launch name and see tab Unique Errors on the top +- [#1268](https://github.com/reportportal/reportportal/issues/1268). Support of Azure SAML authorization + +## New plugins +- [Jira Cloud](https://github.com/reportportal/plugin-bts-jira-cloud/packages/1366483) plugin for posting new bugs into Jira Cloud +- [Azure DevOps](https://github.com/reportportal/plugin-bts-azure/packages/1366495) plugin for posting new bugs into ADO Bug tracking + +## Small but nice updates +- New design for Make decision modal (previously Edit defect modal) +- Help & Support functionality for newly deployed instances +- Additional configuration for Similar “To Investigate” functionality (“Min Should Match”) +- Default State for Auto-Analysis is ON + +## Technical updates +- Performance improvements (powerful as a hell) +- Functionality to configure virtual hosts in RabbitMQ for Analyzer + +## Logs into Elastic +With the version 5.7.2 we bring a fundamental change for ReportPortal to store and manage test logs inside Elastic (via Data Streams). +The transition of full logging to elastic will consist of 2 steps: +- version 5.7.2 introduces double logging: both in PG Database and Elastic in parallel +- version 5.8 switch off database logging for logs and will store logs only inside Elastic + +The release timeline between 5.7.2 and 5.8 will be about 3 months. +this period will be enough for the vast of project to generate enough logs history inside elastic, and by switching to version 5.8 after 5.7.2 will eliminate the need for the data migration efforts. +Which means, that if you update to version 5.7.2, use it for 3-4 months before version 5.8, and then update to version 5.8 once it available, there will no any effort required to do the migration. Since all logs will already be stored in Elastic. +Along with version 5.8 we will distribute migration script and instructions for data migration. So that you can easily migration from early 5.x version. +The reason of the switch and performance results will be a subject of separate article. +In a few words: it reduces the DB footprint in almost x10 times, improves speed of logging, and minimizes computation power to clean-up data. And also brings Full text search capabilities. + +## New Contributors +* @raikbitters made their first contribution in [#1749](https://github.com/reportportal/reportportal/pull/1749) +* @tsteenbe made their first contribution in [#1757](https://github.com/reportportal/reportportal/pull/1757) + +**Full Changelog**: [5.7.1...5.7.2](https://github.com/reportportal/reportportal/compare/5.7.1...5.7.2) + +## Bugfixing: +Bug connected to filtering by attributes with "any" and "without any" conditions was fixed diff --git a/docs/releases/Version5.7.3.md b/docs/releases/Version5.7.3.md new file mode 100644 index 000000000..acb03f70b --- /dev/null +++ b/docs/releases/Version5.7.3.md @@ -0,0 +1,53 @@ +--- +sidebar_position: 3 +sidebar_label: Version 5.7.3 +--- + +# Version 5.7.3 + +## Features: + +- Implemented functionality to find Next and Previous Error Logs. + Buttons “Show”, “Next” and “Previous” error logs minimize user’s efforts of scrolling across all the available logs. +- Improved lazy loading: the number of pre-loaded logs is 300 which helps to get a better understanding of preconditions to a certain error. What is more, now it’s possible to load 300 more logs or load all the current step at once. +- “Stack trace” in log messages now loads all the Error Logs. + Besides, with the help of “Jump to” button on the Error Log it’s possible to switch to this Error Log displayed in the “All Logs” view. + +## Small and nice updates: + +[#3109](https://github.com/reportportal/service-ui/pull/3109) Launch and test item description limits have been increased to 2048. Improved description view on all the “Launches” pages means that now even more useful links, artifacts, OKRs, etc can be stored in the description. + +## Bugfixing: +We have refactored logs double-entry saving to Elasticsearch by changing index type: now logs are saved in indexes per project instead of indexes per launch. It helps us to save the performance of Elasticsearch considering other operations and the data which we have processed via Elastic. +More details can be found via the [link](https://reportportal.io/blog/performance-improvements-in-5.7.3?utm_source=trigger&utm_medium=release_note&utm_campaign=perf_improve&utm_content=dec). + +## Technical updates: + +- Updated RabbitMQ to 3.10.7. +- Environment variable added for Service Jobs to configure http/https usage (added to values.yaml for RabbitMQ as well). +- Added the logics of logs deletion (by jobs): when the logs are deleted by jobs from PostgreSQL, they are also deleted from ElasticSearch. + +## CVE addressed: + +- [CVE-2017-18640](https://github.com/advisories/GHSA-rvwf-54qp-4r6v) +- [CVE-2020-17527](https://github.com/advisories/GHSA-vvw4-rfwf-p6hx) +- [CVE-2020-25032](https://github.com/advisories/GHSA-xc3p-ff3m-f46v) +- [CVE-2020-25638](https://github.com/advisories/GHSA-j8jw-g6fq-mp7h) +- [CVE-2021-22112](https://github.com/advisories/GHSA-gq28-h5vg-8prx) +- [CVE-2021-22118](https://github.com/advisories/GHSA-gfwj-fwqj-fp3v) +- [CVE-2021-22119](https://github.com/advisories/GHSA-w9jg-gvgr-354m) +- [CVE-2021-25122](https://github.com/advisories/GHSA-j39c-c8hj-x4j3) +- [CVE-2021-25329](https://github.com/advisories/GHSA-jgwr-3qm3-26f3) +- [CVE-2021-29510](https://github.com/advisories/GHSA-5jqp-qgf6-3pvh) +- [CVE-2021-33503](https://github.com/advisories/GHSA-q2q7-5pp4-w6pg) +- [CVE-2021-35515](https://github.com/advisories/GHSA-7hfm-57qf-j43q) +- [CVE-2021-35516](https://github.com/advisories/GHSA-crv7-7245-f45f) +- [CVE-2021-35517](https://github.com/advisories/GHSA-xqfj-vm6h-2x34) +- [CVE-2021-36090](https://github.com/advisories/GHSA-mc84-pj99-q6hh) +- [CVE-2022-21724](https://github.com/advisories/GHSA-v7wg-cpwc-24m4) +- [CVE-2022-22970](https://github.com/advisories/GHSA-hh26-6xwr-ggv7) +- [CVE-2022-22978](https://github.com/advisories/GHSA-hh32-7344-cg2f) +- [CVE-2022-24761](https://github.com/advisories/GHSA-4f7p-27jc-3c36) +- [CVE-2022-25857](https://github.com/advisories/GHSA-3mc7-4q67-w48m) +- [CVE-2022-27772](https://github.com/advisories/GHSA-cm59-pr5q-cw85) + diff --git a/docs/releases/Version5.7.4.md b/docs/releases/Version5.7.4.md new file mode 100644 index 000000000..fcd3254de --- /dev/null +++ b/docs/releases/Version5.7.4.md @@ -0,0 +1,31 @@ +--- +sidebar_position: 2 +sidebar_label: Version 5.7.4 +--- + +# Version 5.7.4 + +## What's Changed: +1. ReportPortal previously used MinIO Client for file storage, which offered such benefits as: + +- Easy Docker-based installation +- Kubernetes Support +- S3-compatible bridge which allows to delegate file storage to S3, but keep using MinIO API + +But since there have been some changes in MinIO, we have explored alternative clients for working with cloud storage. + +Changes in MinIO: +- a licensing shift to AGPL which does not allow to have MinIO dependencies in the code anymore +- deprecation of S3 Proxy Gateway highly utilized in client installations + +Thus, we have replaced MinIO Client with JCloud in the latest ReportPortal version. +Starting from ReportPortal 5.7.4 you can either use AWS S3 directly or continue with your existing MinIO as object storage. + + + + +2. **IMPORTANT:** + +**Please, don’t forget to update ElasticSearch config.** +We've enabled logs double entry by default. Thus, it is important to review your ElasticSearch setup. +Please, read carefully through this [migration guide](https://github.com/reportportal/reportportal/wiki/Migration-to-ReportPortal-v.5.7.4) in order to avoid performance pitfalls. diff --git a/docs/releases/Versionv23.1.md b/docs/releases/Versionv23.1.md new file mode 100644 index 000000000..568b74abc --- /dev/null +++ b/docs/releases/Versionv23.1.md @@ -0,0 +1,84 @@ +--- +sidebar_position: 1 +sidebar_label: Version v.23.1 +--- + +# Version v.23.1 + +# 1. What's Changed: + +- **New ReportPortal logo** + We are thrilled to unveil our refreshed brand identity with a brand-new logo for ReportPortal. As part of our ongoing commitment to innovation and evolution, we have embarked on a rebranding and redesign process to give our product a fresh, modern look and align with the exciting changes ahead. + +- **Enhanced permissions:** + Unlock the power of collaboration with limitless access to project filters, widgets, and dashboards for every project member. Now it will be simpler. + +- **Rally/Jira Server effortless Integration:** + Post issues from ReportPortal to Jira and Rally seamlessly, without manual credentials. + +- **Updated widget validation**: + Easily create widgets with identical names across multiple dashboards. + +- **Launch import improvements:** + Get enhanced flexibility with the possibility to upload launches as both .ZIP and .XML files. + +- **Attributes logics improvement:** + No more need for creating separate rules for each attribute. Save your time with the integrated option to select either 'All' or 'Any' attributes when creating a Notification rule. + +- **Additional email notification on password change:** + Email notifications will always be sent to you whenever your password is changed so that you could promptly take action in case any unauthorized changes are made by third parties. + + +# 2. Technical Improvements: + +- **Initial Admin Passwords updates:** + We’ve adjusted the existing approach: upon the initial installation and the first login of the SuperAdmin, they will be required to create a unique initial password, distinct from the default password provided in the ReportPortal installation documentation. Failure to do so will result in the Auth service not starting. + +- **Removal of Sure Python dependency:** + To ensure compatibility with the Apache2 license, we have eliminated Sure Python dependency from ReportPortal. + +- **Updated RabbitMQ image** + RabbitMQ image updated to `bitnami/rabbitmq:3.10.8-debian-11-r7` + +- **Services health checks** + Added health checks for API, Jobs, and UAT services + +- **New environments variables for Double Entry that processes logs by Jobs service** + `RP_PROCESSING_LOG_MAXBATCHSIZE` and `RP_PROCESSING_LOG_MAXBATCHTIMEOUT` + +# 3. Enhancements Based on Community Feedback: + +- [#41](https://github.com/reportportal/plugin-bts-jira/issues/41). JIRA integration throws errors while setting up. +- [#243](https://github.com/reportportal/service-authorization/issues/243). Email not synchronized after change. +- [#287](https://github.com/reportportal/kubernetes/issues/287). Serviceui securityContext issue: + The release UI image is now based on the non-root nginx image, which is more secure. +- [#1013](https://github.com/reportportal/reportportal/issues/1013). Display more results in Flaky/Most Failed test case tables: + The number of items in Most failed test-cases table (TOP-20) has been increased from 20 to 50. +- [#1618](https://github.com/reportportal/reportportal/issues/1618). [v5] Okta SSO login is not possible. +- [#1790](https://github.com/reportportal/reportportal/issues/1790). URL links to dashboard are not loading the widgets. +- [#1868](https://github.com/reportportal/reportportal/issues/1868). Client exception with client-javascript, Request failed with status code 400: + The maximum length of Attribute Key and Value has been increased to 512 characters. +- [#1891](https://github.com/reportportal/reportportal/issues/1891). Cannot report test results to the project with "demo" name. +- [#1912](https://github.com/reportportal/reportportal/issues/1912). Cloud Jira Integration Post Issue is not Coming. +- [#3132](https://github.com/reportportal/service-ui/issues/3132). Component Health Check - Needs to wrap text: + The table now includes a new column named 'Name'. Hovering over the value in the table will display a tooltip with the full text of the value. + +# 4. CVE addressed: + +- [CVE-2018-10237](https://github.com/advisories/GHSA-mvr2-9pj6-7w5j), [CVE-2018-12022](https://github.com/advisories/GHSA-cjjf-94ff-43w7), [CVE-2018-12023](https://github.com/advisories/GHSA-6wqp-v4v6-c87c), [CVE-2018-14718](https://github.com/advisories/GHSA-645p-88qh-w398), [CVE-2018-14719](https://github.com/advisories/GHSA-4gq5-ch57-c2mg), [CVE-2018-14720](https://github.com/advisories/GHSA-x2w5-5m2g-7h5m), [CVE-2018-14721](https://github.com/advisories/GHSA-9mxf-g3x6-wv74), [CVE-2018-19360](https://github.com/advisories/GHSA-f9hv-mg5h-xcw9), [CVE-2018-19361](https://github.com/advisories/GHSA-mx9v-gmh4-mgqw), [CVE-2018-19362](https://github.com/advisories/GHSA-c8hm-7hpq-7jhg), [CVE-2019-11254](https://github.com/advisories/GHSA-wxc4-f4m6-wwqv), [CVE-2019-12814](https://github.com/advisories/GHSA-cmfg-87vq-g5g4), [CVE-2019-14892](https://github.com/advisories/GHSA-cf6r-3wgc-h863), [CVE-2019-14893](https://github.com/advisories/GHSA-qmqc-x3r4-6v39), [CVE-2019-16335](https://github.com/advisories/GHSA-85cw-hj65-qqv9), [CVE-2019-16942](https://github.com/advisories/GHSA-mx7p-6679-8g3q), [CVE-2019-16943](https://github.com/advisories/GHSA-fmmc-742q-jg75), [CVE-2019-17267](https://github.com/advisories/GHSA-f3j5-rmmp-3fc5), [CVE-2019-17531](https://github.com/advisories/GHSA-gjmw-vf9h-g25v), [CVE-2019-20330](https://github.com/advisories/GHSA-gww7-p5w4-wrfv), [CVE-2020-10650](https://github.com/advisories/GHSA-rpr3-cw39-3pxh), [CVE-2020-10672](https://github.com/advisories/GHSA-95cm-88f5-f2c7), [CVE-2020-10673](https://github.com/advisories/GHSA-fqwf-pjwf-7vqv), [CVE-2020-10968](https://github.com/advisories/GHSA-rf6r-2c4q-2vwg), [CVE-2020-10969](https://github.com/advisories/GHSA-758m-v56v-grj4), [CVE-2020-11111](https://github.com/advisories/GHSA-v3xw-c963-f5hc), [CVE-2020-11112](https://github.com/advisories/GHSA-58pp-9c76-5625), [CVE-2020-11619](https://github.com/advisories/GHSA-27xj-rqx5-2255), [CVE-2020-11620](https://github.com/advisories/GHSA-h4rc-386g-6m85), [CVE-2020-13956](https://github.com/advisories/GHSA-7r82-7xv7-xcpj), [CVE-2020-14040](https://github.com/advisories/GHSA-5rcv-m4m3-hfh7), [CVE-2020-14060](https://github.com/advisories/GHSA-j823-4qch-3rgm), [CVE-2020-14061](https://github.com/advisories/GHSA-c2q3-4qrh-fm48), [CVE-2020-14062](https://github.com/advisories/GHSA-c265-37vj-cwcc), [CVE-2020-15138](https://github.com/advisories/GHSA-wvhm-4hhf-97x9), [CVE-2020-24750](https://github.com/advisories/GHSA-qjw2-hr98-qgfh), [CVE-2020-25649](https://github.com/advisories/GHSA-288c-cq4h-88gq), [CVE-2020-29652](https://github.com/advisories/GHSA-3vm4-22fp-5rfm), [CVE-2020-35728](https://github.com/advisories/GHSA-5r5r-6hpj-8gg9), [CVE-2020-36179](https://github.com/advisories/GHSA-9gph-22xh-8x98), [CVE-2020-36180](https://github.com/advisories/GHSA-8c4j-34r4-xr8g), [CVE-2020-36181](https://github.com/advisories/GHSA-cvm9-fjm9-3572), [CVE-2020-36182](https://github.com/advisories/GHSA-89qr-369f-5m5x), [CVE-2020-36183](https://github.com/advisories/GHSA-9m6f-7xcq-8vf8), [CVE-2020-36184](https://github.com/advisories/GHSA-m6x4-97wx-4q27), [CVE-2020-36185](https://github.com/advisories/GHSA-8w26-6f25-cm9x), [CVE-2020-36186](https://github.com/advisories/GHSA-v585-23hc-c647), [CVE-2020-36187](https://github.com/advisories/GHSA-r695-7vr9-jgc2), [CVE-2020-36188](https://github.com/advisories/GHSA-f9xh-2qgp-cq57), [CVE-2020-36189](https://github.com/advisories/GHSA-vfqx-33qm-g869), [CVE-2020-36518](https://github.com/advisories/GHSA-57j2-w4cx-62h2), [CVE-2020-7746](https://github.com/advisories/GHSA-h68q-55jf-x68w), [CVE-2020-8840](https://github.com/advisories/GHSA-4w82-r329-3q67), [CVE-2021-20190](https://github.com/advisories/GHSA-5949-rw7g-wx7w), [CVE-2021-22060](https://github.com/advisories/GHSA-6gf2-pvqw-37ph), [CVE-2021-22096](https://github.com/advisories/GHSA-rfmp-97jj-h8m6), [CVE-2021-23341](https://github.com/advisories/GHSA-h4hr-7fg3-h35w), [CVE-2021-30640](https://github.com/advisories/GHSA-36qh-35cm-5w2w), [CVE-2021-32723](https://github.com/advisories/GHSA-gj77-59wh-66hg), [CVE-2021-33037](https://github.com/advisories/GHSA-4vww-mc66-62m6), [CVE-2021-3801](https://github.com/advisories/GHSA-hqhp-5p83-hx96), [CVE-2021-38561](https://github.com/advisories/GHSA-ppp9-7jff-5vj2), [CVE-2021-41079](https://github.com/advisories/GHSA-59g9-7gfx-c72p), [CVE-2021-4235](https://github.com/advisories/GHSA-r88r-gmrh-7j83), [CVE-2021-4279](https://github.com/advisories/GHSA-8gh8-hqwg-xf34), [CVE-2022-22950](https://github.com/advisories/GHSA-558x-2xjg-6232), [CVE-2022-22965](https://github.com/advisories/GHSA-36p3-wjmg-h94x), [CVE-2022-22969](https://github.com/advisories/GHSA-c2cp-3xj9-97w9), [CVE-2022-23181](https://github.com/advisories/GHSA-9f3j-pm6f-9fm5), [CVE-2022-24785](https://github.com/advisories/GHSA-8hfj-j24r-96c4), [CVE-2022-24999](https://github.com/advisories/GHSA-hrpp-h998-j3pp), [CVE-2022-27191](https://github.com/advisories/GHSA-8c26-wmh5-6g9v), [CVE-2022-28948](https://github.com/advisories/GHSA-hp87-p4gw-j4gq), [CVE-2022-31129](https://github.com/advisories/GHSA-wc69-rhjr-hc9g), [CVE-2022-32149](https://github.com/advisories/GHSA-69ch-w2m2-3vjp), [CVE-2022-40150](https://github.com/advisories/GHSA-x27m-9w8j-5vcw), [CVE-2022-40152](https://github.com/advisories/GHSA-3f7h-mf4q-vrm4), [CVE-2022-42003](https://github.com/advisories/GHSA-jjjh-jjxp-wpff), [CVE-2022-42004](https://github.com/advisories/GHSA-rgv9-q543-rqg4), [CVE-2022-42252](https://github.com/advisories/GHSA-p22x-g9px-3945), [CVE-2022-45685](https://github.com/advisories/GHSA-7rf3-mqpx-h7xg). + +# 4. Link to Migration guide: +https://github.com/reportportal/reportportal/wiki/Migration-to-ReportPortal-v.23.1 + +# 5. Released versions + +|Service Name|Repository|Tag| +|---|---| --- | +|Index|reportportal/service-index|5.8.0| +|Authorization|reportportal/service-authorization|5.8.0| +|UI|reportportal/service-ui|5.8.0| +|API|reportportal/service-api|5.8.0| +|Jobs|reportportal/service-jobs|5.8.0| +|Migrations|reportportal/migrations|5.8.0| +|Auto Analyzer|reportportal/service-auto-analyzer|5.7.5| +|Metrics Gatherer|reportportal/service-metrics-gatherer|5.7.4| diff --git a/docs/releases/_category_.json b/docs/releases/_category_.json new file mode 100644 index 000000000..a976b7146 --- /dev/null +++ b/docs/releases/_category_.json @@ -0,0 +1,7 @@ +{ + "label": "Releases", + "position": "5", + "link": { + "type": "generated-index" + } +} diff --git a/docs/releases/img/5.7.4.png b/docs/releases/img/5.7.4.png new file mode 100644 index 000000000..19cede312 Binary files /dev/null and b/docs/releases/img/5.7.4.png differ diff --git a/docs/reportportal-configuration/HowToGetAnAccessTokenInReportPortal.mdx b/docs/reportportal-configuration/HowToGetAnAccessTokenInReportPortal.mdx index 039e1c2c5..775130c0e 100644 --- a/docs/reportportal-configuration/HowToGetAnAccessTokenInReportPortal.mdx +++ b/docs/reportportal-configuration/HowToGetAnAccessTokenInReportPortal.mdx @@ -53,7 +53,7 @@ Another method involves using the API Key found on the user's Profile page. The API Key is a unique token that grants access to the ReportPortal REST API. -To use it, log in and navigate to the Profile page, then find the API Keys tab. If you've previously created a token, it now has been converted to a Legacy API Key at the moment of migration to newest version and it remains valid and operational. +To use it, log in and navigate to the Profile page, then find the API Keys tab. If you’ve previously integrated agents using UUID, it has been converted to a Legacy API Key at the moment of migration to newest version and it remains valid and operational. :::note It will continue to work even if you generate new API Keys. diff --git a/docs/reportportal-configuration/_category_.json b/docs/reportportal-configuration/_category_.json index 9d2d53dd3..abbb29645 100644 --- a/docs/reportportal-configuration/_category_.json +++ b/docs/reportportal-configuration/_category_.json @@ -1,6 +1,6 @@ { "label": "ReportPortal Configuration", - "position": "4", + "position": "5", "link": { "type": "generated-index" } diff --git a/docs/reportportal-glossary/index.mdx b/docs/reportportal-glossary/index.mdx index 7b4818c95..83428514e 100644 --- a/docs/reportportal-glossary/index.mdx +++ b/docs/reportportal-glossary/index.mdx @@ -1,5 +1,5 @@ --- -sidebar_position: 16 +sidebar_position: 20 sidebar_label: ReportPortal Glossary --- diff --git a/docs/reportportal-tutorial/index.mdx b/docs/reportportal-tutorial/index.mdx index afc62fe2f..836dcf74b 100644 --- a/docs/reportportal-tutorial/index.mdx +++ b/docs/reportportal-tutorial/index.mdx @@ -1,5 +1,5 @@ --- -sidebar_position: 2 +sidebar_position: 3 sidebar_label: ReportPortal Tutorial description: ReportPortal guide. How to do test failure analysis, how to create dashboard to manage test results and use capabilities of continuous testing platform. --- diff --git a/docs/saved-searches-filters/_category_.json b/docs/saved-searches-filters/_category_.json index dd12bfc3f..5fbc856bf 100644 --- a/docs/saved-searches-filters/_category_.json +++ b/docs/saved-searches-filters/_category_.json @@ -1,6 +1,6 @@ { "label": "Saved searches (filters)", - "position": "9", + "position": "12", "link": { "type": "generated-index" } diff --git a/docs/terms-and-conditions/_category_.json b/docs/terms-and-conditions/_category_.json index fca45c950..18f12d9c8 100644 --- a/docs/terms-and-conditions/_category_.json +++ b/docs/terms-and-conditions/_category_.json @@ -1,6 +1,6 @@ { "label": "Terms & conditions", - "position": "16", + "position": "22", "link": { "type": "generated-index" } diff --git a/docs/user-account/_category_.json b/docs/user-account/_category_.json index e792897cb..0bc4a3390 100644 --- a/docs/user-account/_category_.json +++ b/docs/user-account/_category_.json @@ -1,6 +1,6 @@ { "label": "User account", - "position": "5", + "position": "7", "link": { "type": "generated-index" } diff --git a/docs/user-role-guides/index.md b/docs/user-role-guides/index.md index 0db7f212b..df94135d0 100644 --- a/docs/user-role-guides/index.md +++ b/docs/user-role-guides/index.md @@ -1,5 +1,5 @@ --- -sidebar_position: 14 +sidebar_position: 17 sidebar_label: User role guides --- diff --git a/docs/work-with-reports/_category_.json b/docs/work-with-reports/_category_.json index cc45a8f11..6915464df 100644 --- a/docs/work-with-reports/_category_.json +++ b/docs/work-with-reports/_category_.json @@ -1,6 +1,6 @@ { "label": "Work with reports", - "position": "7", + "position": "10", "link": { "type": "generated-index" }