GO Live checklist

Introduction 

The GO Live checklist extension provides a backend module to track release readiness per site. It lets editors run checklist sessions, review items, and mark pages as pass or fail. Page tree labels show status at a glance when an active session is set.

Key features 

  • Checklist sessions per site, with share and close options.
  • Checklist items defined in the database (global or site-specific).
  • Page status tracking and page tree labels for the active session.
  • Export of checklist data to PDF.

Installation 

  1. Install the extension as usual (Composer or Extension Manager). Composer example: composer require hyperdigital/hd-golive
  2. Flush caches in the backend.
  3. Run the database schema update to add required tables and fields.

Database schema 

The extension adds tables:

  • tx_hdgolive_session
  • tx_hdgolive_checkitem
  • tx_hdgolive_itemcheck
  • tx_hdgolive_pagecheck
  • tx_hdgolive_note
  • tx_hdgolive_pagenote

Configuration 

Checklist items are stored as records in tx_hdgolive_checkitem.

Item scoping 

Checklist items are resolved by PID:

  • PID 0: global items used for all sites
  • PID = site root page ID: items for that site only

If both exist, items are combined. Items with the same key are overridden by the later entry (site-specific wins).

Page inclusion 

Pages shown in the checklist are controlled by the extension setting includeDoktypes (comma-separated). When empty, all doktypes are included. When set, only those doktypes are included unless overridden per page.

Two page properties are available on default-language pages:

  • Exclude from GO Live checklist: force a page out of the checklist.
  • Include in GO Live checklist: force a page into the checklist.

The include flag wins over exclude. If neither is set, the doktype setting applies.

Item fields 

  • Title
  • Key (unique identifier used by item checks)
  • Description (shown on the item detail page)

Where to create items 

Create records in the backend list module:

  • Use PID 0 for global items.
  • Use the site root page for site-specific items.

Usage 

Start a session 

  1. Open the "GO Live" module.
  2. Select a site.
  3. Start a new checklist session.

Sharing a session 

Shared sessions are visible to all users with access to the module. Use the "Share session" button in the module header to toggle sharing.

Checklist items 

  • The checklist table lists items for the current session.
  • Click an item title to open the detail view and edit its definition.
  • Change the status from pending to pass or failed.

Pages 

  • Page status is tracked per session.
  • The page tree shows colored "GO Live" labels when a session is active.
  • Use the page properties "Include in GO Live checklist" or "Exclude from GO Live checklist" (default-language pages only) to override the doktype filter.

Export 

Use the export button to download the checklist as PDF.

Permissions 

There are two ways to allow checklist visibility:

  1. Grant access to the "GO Live" module (module key: web_hdgolive).
  2. Enable the custom permission option: "GO Live checklist -> View checklist items".

If either is granted, the checklist items and page tree labels are visible. If neither is granted, the module shows an info message and the page tree labels are hidden.

After changing group permissions, users must log out and log in again.