Introduced in 1.5.0
We're introducing baselines. It's a way of versioning your requirements.
Baselines can be useful:
- When you want to test a specific version of your software,
- When requirements evolve after you've raised a JIRA issue,
- To keep track of requirements that have been approved by a client.
Create a baseline of a subset of the requirements
A baseline contains a snapshot of your requirements at a given point of time. You can create a baseline from the blueprint or from the search. The "Make baseline" button is available on the search screen:
Baselines are represented by a page
You can add the description of your release (release notes, testing, etc) on that page:
The page of the baseline links to the frozen version of the requirements. They display the history version of the page they're on.
See baselines in the page history
When you view an old version of a page, the detail popup shows the details of the baseline.
That's it !
To remember:
- To create a baseline, use the blueprint, then click "Freeze requirements".
- When clicking this button, requirements are copied, in order to "archive" the current version. You can see them in the search with status = "ARCHIVED"
- After clicking this button, you can keep changing the original requirements, but it won't change the baseline.
- Confluence doesn't prevent users from deleting pages or add-ons from modifying old versions of pages. It is the administrator's role to configure permissions accordingly. If a page is deleted, the archived requirement remains in the baseline and you can view it in the popup.
- You can create a baseline on all requirements, or select a subset. You need to enter this query when you create the blueprint, but the requirements will only be frozen when you press the button "Freeze".
Compatible with JIRA
In JIRA, it is possible to link an issue to a specific baseline of the requirements. So your client can't change requirements on the fly!
In the JIRA link dialog, click "Baselines". Tip: If the baselines don't show, it means your administrator has not configured |  |
| Once you've ticked a baseline, search for requirements. Only those in the baseline will display. |  |
| Tip: If you want to upgrade from one version to the next, click "Update to v4". |  |
Dos and Don'ts
| Do | Don't |
|---|---|
| From JIRA, only use links to baselines when you are writing a bug report about a specific version. | From JIRA, don't link to the baseline of a requirement that you want to evolve. It is much easier to just link to whatever the current version is, then let JIRA update it whenever it is updated. |
See all your baselines at a glance
Search for requirements that have been modified since a baseline
There is a special query term: isModified('1')
- It shows all requirements which have been modified since "baseline 1";
- You can as well write the name of the baseline:
isModified("Release 1.3c")