-
Notifications
You must be signed in to change notification settings - Fork 99
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Baseline management doc and images added #3005
Open
marstupa
wants to merge
12
commits into
main
Choose a base branch
from
IRIS-1342-baseline-management-docs
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
6917271
baseline management doc and images added
marstupa 24c1f76
casing change for navigation items
marstupa bbbf06e
Merge branch 'main' into IRIS-1342-baseline-management-docs
marstupa 0c56acb
vale wording updates to baseline management page
marstupa 6aea01f
Merge branch 'IRIS-1342-baseline-management-docs' of https://github.c…
marstupa 999c025
baseURL import and case change
marstupa e00c9fc
navigation import
marstupa b60f102
removed unneeded imports & ids
marstupa 63f2843
sidebar item added
marstupa 3529164
Update docs/visual-testing/workflows/baseline-management.md
marstupa ae161e7
replaced diff image and updated text for baselines page
marstupa 48a3e14
option emphasis, removed extra spaces
marstupa File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
@@ -0,0 +1,46 @@ | ||||||
--- | ||||||
sidebar_label: Baseline Management (BETA) | ||||||
--- | ||||||
|
||||||
import useBaseUrl from '@docusaurus/useBaseUrl'; | ||||||
|
||||||
# Baseline Management | ||||||
|
||||||
The Baseline Management feature lets you oversee the approved visual snapshots from your tests. | ||||||
It allows you to track visual regressions through time and check baselines for different branches and projects. | ||||||
Additionally, you can view the baseline history, download images, and view associated build details. | ||||||
|
||||||
While logged in to Sauce Labs, navigate to this feature by clicking the "Visual -> Baselines" in the side navigation. | ||||||
|
||||||
<img src={useBaseUrl('img/sauce-visual/baselines-navigation.jpg')} alt="Baselines navigation item" /> | ||||||
|
||||||
## Baselines Page | ||||||
|
||||||
The Baselines page allows you to view all accepted snapshots in a project and branch. | ||||||
Select a Project at the top and then Branch to view baselines. | ||||||
If these are not set for your tests, all baselines will be displayed together under the `(not set)` option. | ||||||
|
||||||
You can further filter baselines by OS, browser, or device. Options to sort and group are also available. | ||||||
|
||||||
<img src={useBaseUrl('img/sauce-visual/baselines-page.jpg')} alt="Baselines page results" /> | ||||||
|
||||||
## Baseline History View | ||||||
|
||||||
Baseline History allows you to view and manage historical snapshots of a single test baseline. | ||||||
This view opens after you click on any snapshot from the Baselines page. | ||||||
|
||||||
<img src={useBaseUrl('img/sauce-visual/baseline-history.jpg')} alt="Baseline history view displaying a snapshot with list of changes in time" /> | ||||||
|
||||||
Once inside Baseline History view, you can perform the following actions by clicking the `...` button on any item in the list: | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
- **Set as New Baseline**: Mark older approvals of a snapshot as the new baseline for visual comparison. | ||||||
- **Download Image**: Download individual snapshot for local viewing or archiving. | ||||||
- **View Build**: Access visual build details where a certain version of the snapshot was approved. | ||||||
|
||||||
<img src={useBaseUrl('img/sauce-visual/baseline-history-options.jpg')} alt="Baseline history options dropdown showing three options" /> | ||||||
|
||||||
## Accessing Baseline History From Build Details | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
I think this is more accurate |
||||||
|
||||||
For easier reviewing experience and navigating to and from baselines, the test runs with pre-approved baselines will show a link to Baseline history at the top. | ||||||
|
||||||
<img src={useBaseUrl('img/sauce-visual/build-overlay-history.jpg')} alt="Build run displaying a link to Baseline history at the top" /> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.