Baselines Baselines Docs
Docs › Documents › Freeze (take a baseline)

Freeze (take a baseline)

Freeze is how you take a baseline. It records which version of each page a document holds, as of now or as of an earlier date, and gives that record a version label such as v1.0. Freeze several documents in one step and, if you like, bundle them as a release.

Formerly Create Baseline

Freeze does what Create Baseline did, and freezing a document again does what Retake did: it takes the same root pages, and pages added under them since come along. Freezing needs the Freeze permission.

Open Freeze

The Freeze screen with three documents picked, their next labels, Add to a release ticked and What this freeze makes
Freeze: three documents picked into Release 1.2

Pick documents

Every document is listed, the picked ones first. Tick the ones to freeze, or use Pick every changed document and Clear.

ColumnMeaning
DocumentIts name, space, and its last version with its date.
Since the last versionWhat changed, checked as you, for example 2 pages changed since v1.1, with the pages that come with this freeze (1 new page under Test Plan will be included) and those that drop out.
Next versionThe label the new version gets. Baselines offers the last number counted up (v1.1 after v1.0, v2.1 after v2.0); type your own, such as v2.0. It must be a number, because the label is read back from the version’s name.
ScopeThis page only, With attachments or With everything under it, taken from how the last version was frozen. As last time appears when the last selection fits none of the three, and takes the same selection again.

A version is stored as a baseline named after the document’s short name, its label and its release, for example SRS v2.0 Release 1.0. The card of a version shows this as Name as frozen.

Add pages

Pages that are not in a document yet become a new document. Add pages opens the space tree: choose the space, search page titles if you like, and tick the page your document starts from. A tick takes the page alone; on each ticked row choose what comes with it: its attachments, or everything under it. On the right, name the new document (suggested from the first root page’s title), give it a Short name of up to five letters or digits for its colour chip, and its First version. Add to this freeze adds it as a row. To take pages by a label, a date, a person or words in the title instead, see Find pages by a rule.

Add pages: the space tree of Pump Controller with Software Requirements Specification ticked with everything under it
Add pages: tick a root page in the space tree and choose what comes with it

If a page you tick is already in a document, Baselines asks whether to add it as that document’s next version or to start a new document. A page can be in more than one document.

Find pages by a rule

Instead of ticking pages one by one, describe the pages your document takes. Click the bar beside the space and pick a field: Label, Changed since, Created by, Title has or Under page. As you type, Baselines suggests what the space holds, each with how many of its pages it takes, counted as you: its labels, people, pages that have pages under them, and the last 7 or 30 days. Press Enter to add a suggestion as a chip, and add as many as you need; Backspace removes the last one.

Add pages in Pump Controller: the rule bar with Label picked and the labels interface, review and safety suggested with their page counts
Pick a field, then a value: each suggestion says how many pages of the space it takes

Each change runs the rule. The line under the bar says how many pages match, and the tree opens to show them, marked in blue with their labels. Choose what comes with each match and press Tick all; you can still tick or untick any page yourself.

Add pages: the rule Label safety matches four pages in Pump Controller, all ticked, for a new document named Safety case with Keep the rule ticked
Label safety: four pages from three documents, ticked into a new document

Keep the rule, on the right, makes the rule part of the document. Every later freeze of the document runs the rule again, as the person freezing, and takes the pages it matches then: a page labelled safety next month comes along by itself. On Freeze, such a document says Runs its rule again and its scope reads By its rule. Pages you unticked stay out, and pages you ticked besides stay in.

Edit as CQL shows the rule in Confluence Query Language, and lets you write any CQL search, with field names suggested as you type. Back to chips turns what it can into chips again; the rest stays as one CQL chip. A person and a page to look under stay chips.

Good to know:

Add to a release

Tick Add to a release to bundle the new versions under one name, such as a gate or a delivery. Baselines offers a name that follows the last release (Release 1.1 follows Release 1.0); type your own if you like, and add Notes, optional. The release is made first, so a freeze that stops part way can be carried on from the release’s page. See Releases.

As of now or an earlier date

As of now, each document records the page versions that exist when its freeze runs. Use an earlier date opens Freeze as of an earlier date: pick a date and a time in your Confluence time zone, and Baselines finds, for every page, the version that existed at that moment, reading as you. The dialog shows where each new version lands among the document’s versions and offers a label that fits there.

Freeze and follow it

Press Freeze (it says how many documents, for example Freeze 3 documents). Baselines first checks every label and name; rows that need a change are marked, and nothing is frozen until they are right. Then it freezes the documents one after another, as a job in Jobs. You can move to other screens while it runs. The panel beside the list, What this freeze makes, fills in as each document is frozen, and ends with Open the release, Back to documents and Freeze more.

Keep Baselines open

A freeze moves only while a tab shows Baselines. If that tab closes part way, Documents says A freeze stopped when its tab closed and offers Resume and Discard the rest; what was frozen stays. A freeze into a release can also be carried on from the release’s page, in any browser.

What a version holds

A version records which version of each page and attachment in its scope existed: With attachments takes the attachments right under each root page, With everything under it takes every page, attachment, folder, whiteboard, database and Smart Link under it. Folders and the like keep their place, so the pages under a folder stay under it, and comparing two versions counts them apart from the pages: Besides the pages: 1 folder added. Baselines stores pointers to those versions in Confluence, not copies of the pages. Freezing never changes a page.



Was this page helpful?   Yes · No  ·  Contact support