Working With Draft and Baseline Versions
This section covers an essential workflow feature of Squore: baselining. While it is possible to keep every version of a project created in Squore, you may want to permanently keep analysis results only for particular milestones and work with an always updating draft version.
You can decide whether a version is a draft or a baseline when you create it, or after the analysis is finished.
Basic concepts
The most important thing to remember about a draft version is that it is a snapshot of your data at a given time. You can use it to compare the evolution of your project against the last baseline created. There is therefore only one draft version available per project (the latest version), which Squore creates automatically if your previous version was a baseline. A baseline version, on the other hand, is permanently saved and will not be overwritten the next time an analysis is launched.
When you create a draft version, it is always called Current and can be modified in several ways:
-
Forms can be updated
-
Attribute values can be modified so that a new value is taken into account in the next analysis
-
Artefacts can be manually added, modified or deleted
-
Folders and files can be relaxed or excluded from the project
-
Action Items can have their status changed
-
Rules and individual violations can be relaxed
Being able to view draft versions of a project is a user privilege that can be granted to users of a particular project role, and so is the ability to baseline a project. For more information about project roles, refer to Project Roles. This means that as a project manager, you can give access to every version to users within your team, but can restrict the project visibility to the rest of the company to show them only baselined versions. You can also decide which members of your team are allowed to change the status of a version from draft to baseline.
Baselining at version creation
Use the Automatic Baselining option on the General Information screen of the project wizard to create a draft or baseline as follows:
-
When the Automatic Baselining box is unchecked, a draft version is created and all subsequent versions will be draft versions by default.
-
When the Automatic Baselining box is checked, a baseline version is created and all subsequent versions will be baseline versions by default.
|
A baseline version is only created if the project analysis completes successfully. In case of error, a draft version is created. |
Baselining after review
You can use the Baseline option on the Projects page to create a baseline version of the current draft as follows:
-
Log into Squore and click on Projects.
-
Click the Baseline icon (
) next to the project you want to baseline. -
Click the Baseline button to confirm.
After confirming the baseline creation, you are redirected to the Projects page and the last draft version becomes the new latest baseline. All changes made manually to artefacts and findings are kept, and will be incorporated the next time an analysis runs. Note that baselining is only available for users whose project role includes the Baseline Projects privilege. For more information about project roles, refer to Project Roles.
|
Baselining manually is useful if you have reviewed the current draft and have not made any changes to the analysis results. If you have modified form entries or relaxed artefacts and findings in a way that should impact the rating, consider launching a new build or using the Apply Changes button instead of baselining. See Handling manual modifications for more information. |
Handling manual modifications
When you have relaxed and/or excluded artefacts in the current draft, you can get these changes reflected into the dashboard by one of two ways, either running a New Analysis or executing an Apply Changes.
Same is true for findings and after having modified some form values.
- New analysis
-
Running a new analysis allows you to change Repository Connectors or Data Providers settings, if needed. You can also choose if this new analysis should produce a baseline or a draft version. In all cases, the artefacts, action items and findings you relaxed, excluded or modified are taken into account to produce the rating of the new version.
- Apply Changes (
) -
Clicking Apply Changes allows you to merge the manual modifications of artefacts, forms, action items and findings into a new draft version, without re-analysing source code and re-running Data Providers. Manual modifications are simply merged with the existing results to update the rating, which is a lot faster than running a full analysis.
You can also use Apply Changes after having modified your analysis model, in order to update the ratings.
Apply Changes is not available when you have excluded/relaxed artefacts or findings related to stability/cloning. This is because stability/cloning metrics are computed by the Squore Analyzer DP. In these cases, a re-run of the Data Providers is necessary to compute the stability/cloning metrics again.
Managing previous versions
You can delete or rename one or more of the last versions
of a project if needed.
This can be done from the *{projects}* page if you are the project creator or are a member of a {p_role} that allows for managing the project.
If you want to manage the previous analyses of the Earth project, log in as the demo user and click Projects.
Click the Manage icon (
) and open the Versions tab to view the list of versions created for this project:
|
The most recent version always appears at the top of the list. |
By clicking the pen icon next to the version name, you can rename this analysis. Your changes will immediately be reflected in the Project Portfolios.
In order to delete an analysis, check the box next to the version you want to delete. All versions created after the version you selected will also be checked. Click the Delete button to reach a summary page where you can confirm which versions will be deleted, and click Confirm to launch the delete process.
|
If you select to delete all the versions of a project, the entire project will be deleted. |