Releases: scenarioo/scenarioo
Release 5.0.2 - Fix Step View
Bugfixes
- #953 - Unable to display Step View Accessing the step view for step urls containing special characters (spaces, parentheses, etc) works again.
- #951 - Docker doesn't load external application.properties The docker image now has the correct working directory set, so that an externally supplied application.properties file can be used.
Release 5.0.1 - Fix REST Upload of Builds
Bugfixes
- #934 - Upload Build with Rest Service Uploading builds through the REST endpoint works again, no matter what size the zip-file has.
Release 5.0.0 - Standalone Runner
Scenarioo Standalone Runner
- #724 - Scenarioo Standalone Runner: From now on you can run Scenarioo without needing to install a Tomcat or similar java application server, just refer to our Scenarioo Setup Guide
- #778 - Secured REST Endpoints using Spring Security: The way the api key (or password) for using secured REST endpoints has to be configured has fundamentaly changed by introducing Spring Security. For more details, please refer to the Migration Guide
Small Fixes and Improvements
- #717 - Diff Viewer: Styling and UI issues: Various usability improvements.
- #727 - Build Import: UI issues: Information displayed while a build is being imported was improved.
- #895 - Share this page Screenshot link broken for Sketch: The share this page dialog shows the correct image link again when sharing sketches.
- #900 - Application Info Popup disappears if query parameters were not provided: The application information popup will now also be shown if the application is visited for the first time without query parameters.
Breaking Changes and Backwards Compatibility
- Changed Configuration of password for secured REST API calls:
The security mechanism for secured REST endpoints (e.g. to upload a build via REST call) has changed. Therefore the password for these rest endpoints needs to be configured differently. For more details, please refer to the Migration Guide on how to adjust this configuration when migrating.
Apart from this small config change there are no other breaking changes.
You can still deploy Scenarioo as a WAR to your Tomcat, although this is not needed anymore by using the new standalone deployment, as mentioned above.
Supported Scenarioo Format
- The used Scenarioo Data format is still version 2.1. You can safely use Scenarioo 5.0 with the same data format as before and do not have to upgrade the used Scenarioo writer library to use the new Scenarioo viewer version.
- The internal format has not been changed either, so you do not even have to reimport your builds that have been imported with the previous version in the data directory. All build and comparison data will still work with the new version.
Fixed Issues
All issues fixed in this release: List of Fixed Issues.
Known Issues
Please visit our List of Known Issues on GitHub.
Feedback and Support
Don't hesitate to open new issues if you find a bug or problem, or have feedback or questions:
https://github.com/scenarioo/scenarioo/issues/new?labels=feedback
Release 4.0.1 - Fix Screenshot Sharing
Version 4.0.1
Bugfixes
- #751 - Sharing Step Screenshot Sharing screenshot images through direct link with other applications works again. Also the share this page dialog shows the correct link again.
4.0.0 - Diff Viewer Plus for Visual Regression Testing
New Features
- Diff Viewer Plus for Visual Regression Testing:
- Dialog in Frontend to calculate comparisons on the fly without need to configure it.
- Improved REST endpoints to enable triggering comparisons from CI Build Pipelines
- Comparison calculation is faster without need to install GraphicsMagick anymore
- Improved comparisons to be less disk consuming
- Highlight changes is possible in both compared screenshot images
- Improved comparison view for a step
- Management view to see all calculated comparisons, error on comparison calculations and trigger recalculations.
- Many small improvements and simpler configuration of Scenarioo
Please refer to our Changelog for detailed informations about all new features.
Breaking Changes and Backwards Compatibility
This release contains small breaking changes that might have to be considered when updating:
Please refer to our Migration Guide for details about these changes and how to migrate properly.
The Java Writer Library in use is still version 2.1 which is still compatible with Java 6 and upwards.
Also the internal format version is not increased (still 2.1) so that your existing documentation data
does not even have to be reimported after the upgrade and will continue to work with the new version (except for the comparisons).
Fixed Issues
All issues fixed in this release: List of Fixed Issues.
Known Issues
Please visit our List of Known Issues on GitHub.
Feedback and Support
Don't hesitate to open new issues if you find a bug or problem, or have feedback or questions:
https://github.com/scenarioo/scenarioo/issues/new?labels=feedback
3.0.0 - Diff Viewer and Full Text Search
Feature "Diff Viewer"
See what has changed between two builds, including visual comparisons of screenshots.
This is an optional feature that only works if you enable the feature by adding comparisons to config.xml. Also you need to have GraphicsMagick installed for comparisons of the step screenshots.
Feature "Full Text Search"
Full text search for all use cases, scenarios and steps, including search for visible text or even html on your screens.
This is an optional feature that only works if you have Elasticsearch installed and configure the elasticsearch endpoint in config.xml. Once you activated that, you have to reimport existing documentation builds to generate a search index for getting the search on a build activated.
Breaking Changes and Backwards Compatibility
The Scenarioo Viewer Web App requires now Java 8 (before it was Java 6).
Apart from that there are no breaking changes.
The Java Writer Library in use is still version 2.1 which is compatible with Java 6. Also the internal format version is not increased (still 2.1) so that your existing documentation data does not even have to be reimported after the upgrade and will continue to work with the new version.
Fixed issues
See list of fixed issues.
Known issues
Please visit our list of known issues on GitHub.
Feedback and Support
Don't hesitate to open new issues if you find a bug or problem, or have feedback or questions:
https://github.com/scenarioo/scenarioo/issues/new?labels=feedback
2.2.0 - Sketcher
Feature "Sketcher"
#378 UI Prototyping in Scenarioo: Create sketches based on the screenshots in your documentation and share them with your team.
Fixed issues
Known issues
Please visit our list of known issues on GitHub.
You can also open new issues there if you find a bug or problem.
2.1.0 - Screen Annotations
Feature "Screen Annotations"
#149 Mark regions of a screenshot (e.g. where a click or a text entry happens):
Feature "Add build by POST request"
#424 It is now possible to add a new build by POST request. Previously this was only possible using direct file system access (Documentation)
Fixed issues
2.0.1 - Minor Manage Tabs Cleanup
Just a minor fix for consistent shorter tab names under "Manage".
Fixed issues
- #349 Consistent config tab names under "Manage".
2.0.0 - Stable URLs and Object Repository
Project "Stable URLs and Labels"
The aim of the project is to offer more stable URLs that can be used in other documentations to link to Scenarioo steps or step images. On one hand this is done by changing the URL structure of steps and step images and on the other hand by introducing a clever fallback mechanism that finds a similar step or step image of the same page. Furthermore, labels were introduced to label use cases, scenarios, steps and pages. These labels are also considered in the fallback mechanism, if provided.
- Branch Aliases can be defined to point to special branches
- New URL structure for step URLs:
<usecase>/<scenario>/<pageName>/<pageOccurrence>/<stepInPageOccurrence> - Fallback mechanism for outdated URLs that finds a similar step or step image in case the requested step or step image is not found.
- Share step and step image popup with full URLs, also containing the labels for better stability of the URLs
- Labels
- You can now add labels to use cases, scenarios, pages and steps
- Labels are shown in all relevant places
- You can assign colors to specific label values
- Labels are used to improve the fallback mechanism for URLs in case a step or step image is not found
- The page variants navigation has a link to an overview that shows in which use case and scenario the page occurs.
- There's a new special calculated build called last successful scenarios.
- This build is created from the other builds in the same branch.
- The build is only created if you enable it on the configuration page.
- It contains the latest successful version of each scenario.
Project "Object Repository"
In this project we implemented the new revolutionary feature that brings Scenarioo to the next new level.
The object repository makes it possible to browse all application specific objects (just like use cases can be browsed), that can be attached as additional data to scenarios and their steps. Through this you can now easily browse to one specific object and find out where it is referenced in your documentation: in which steps, scenarios or other places.
- Custom Object Tabs: configure additional tabs on the home page of Scenarioo to display all your application specific objects of some types in a list or tree to search for them and browse them (just like use cases and scenarios can be browsed, searched and navigated to). Documentation for how to configure this can be found here
- Default Custom Object Tabs for "Labels" and "Pages" The default configuration of Scenarioo now comes out of the box with 2 predefined custom object tabs on the start page to search for occurences of "Labels" and "Pages".
- Object Overview Page: Every object in your documentation is now documented on its own page, the page shows all details of such an object together with a reference tree (see next point).
- Object Reference Tree: Just like an index for where an object is referenced, the object reference tree displays on each object overview page, in what use cases, scenarios, steps and potentially other objects the currently selected object is referenced. Through this tree you can directly navigate to a step or scenario where the object is referenced. For both pages, there is a comfortable way to filter for any criteria in the complete tree. All matches will be expanded up to the root element and also highlighted. All elements downto the leave will be collapsed.
- Links for Objects in Metadata: Everywhere in metadata where an object is attached, the listed object appears as a link, through this link you can browse to its object overview page, listing in what other places this same object is listed.
- Object Overview for Pages: Also a page is treated as a usual object in Object Repository. The object overview for a page lists all scenarios where the same page occurs. This overview for a page is available through the link "Page-Varants" in the navigation bar of a step page.
Breaking changes
- Slashes and backslashes are not allowed anymore in fields that are used as IDs (branchName, buildName, useCaseName, scenarioName, pageName, objectType, objectName).
- Removed deprecated methods and classes
- Renamed method StepDescription.addDetails(...) to StepDescription.addDetail(...)
Fixed issues
- #220 Additional details available in branches, builds and usecases are displayed as details