Skip to content

Update Playbooks v2.6 checklists documentation#8656

Merged
cwarnermm merged 12 commits intomasterfrom
claude/issue-8654-20260119-2141
Feb 6, 2026
Merged

Update Playbooks v2.6 checklists documentation#8656
cwarnermm merged 12 commits intomasterfrom
claude/issue-8654-20260119-2141

Conversation

@cwarnermm
Copy link
Member

@cwarnermm cwarnermm commented Jan 19, 2026

Updates Mattermost Product Documentation to reflect Playbooks v2.6.0 checklist workflow changes and mobile v2.35.0 updates.

Changes:

  • Channel checklists as first-class workflows for public/private channels
  • Channel-based permissions model

Closes #8654

Generated with Claude Code

- Add channel checklists as first-class workflows from v2.6.0
- Document rebrand from "Playbook Runs" to "Checklists"
- Update mobile v2.35.0 "Playbook checklists" terminology
- Document channel-based permissions vs playbook permissions
- Add API changes: Type field and optional playbook_id
- Include mobile API endpoints for checklist operations
- Mark PR evidence gaps for human validation

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-authored-by: Carrie Warner (Mattermost) <cwarnermm@users.noreply.github.com>
@github-actions
Copy link
Contributor

Newest code from mattermost has been published to preview environment for Git SHA eaea7c0

@github-actions
Copy link
Contributor

Newest code from mattermost has been published to preview environment for Git SHA 402aa46

@github-actions
Copy link
Contributor

Newest code from mattermost has been published to preview environment for Git SHA 849738f

@cwarnermm cwarnermm added the 1: Dev Review Requires review by a core commiter label Jan 21, 2026
@cwarnermm cwarnermm requested a review from jgheithcock January 21, 2026 18:17
@github-actions
Copy link
Contributor

Newest code from mattermost has been published to preview environment for Git SHA 8400aa9

@github-actions
Copy link
Contributor

Newest code from mattermost has been published to preview environment for Git SHA 1427bbf

@github-actions
Copy link
Contributor

Newest code from mattermost has been published to preview environment for Git SHA 0969c58

@cwarnermm
Copy link
Member Author

I'd appreciate help with answers to the following questions as part of this docs lift:

  1. Are there checklist permissions details to call out -- specifically around guest access: can they create checklists if they have channel post permissions?
  2. Can a single channel have both playbook runs and channel checklists? Anything worth noting when both are present, if supported?
  3. What happens if a user loses channel access while actively working on a checklist?
  4. What happens when a channel is archived? Are those checklists available/accessible? What if the channel is unarchived?
  5. Are checklists backed up as part of channel data?
  6. Is it possible for multiple users to edit the same checklist task at the same time? Who wins? Are there safeguards in place against conflicting edits?
  7. Are users notified of checklist updates?
  8. Is there a maximum number or upper limit to the number of checklists for a given channel?

@github-actions
Copy link
Contributor

Newest code from mattermost has been published to preview environment for Git SHA fecf375

@github-actions
Copy link
Contributor

Newest code from mattermost has been published to preview environment for Git SHA 72f592a

@jgheithcock
Copy link

I'd appreciate help with answers to the following questions as part of this docs lift:

  1. Are there checklist permissions details to call out -- specifically around guest access: can they create checklists if they have channel post permissions?
  2. Can a single channel have both playbook runs and channel checklists? Anything worth noting when both are present, if supported?
  3. What happens if a user loses channel access while actively working on a checklist?
  4. What happens when a channel is archived? Are those checklists available/accessible? What if the channel is unarchived?
  5. Are checklists backed up as part of channel data?
  6. Is it possible for multiple users to edit the same checklist task at the same time? Who wins? Are there safeguards in place against conflicting edits?
  7. Are users notified of checklist updates?
  8. Is there a maximum number or upper limit to the number of checklists for a given channel?

Claude reports the following (and I've vetted it and made some parenthetical comments below - @calebroseland & @JulienTant -tagging you in to vet my vetting ;-) ):
Guest Access: Guest users can create and manage channel checklists if they have posting permissions in the channel, but cannot access checklists from private channels they don't belong to.

Coexistence: A single channel can contain both playbook runs and standalone channel checklists simultaneously - channel members have immediate edit access to checklists but must opt-in to become participants before editing playbook runs.

Losing Channel Access: Users who lose channel membership immediately lose all access to that channel's checklists, and any unsaved changes are lost.

Channel Archival: Checklists in archived channels become read-only (viewable but not editable) and regain full functionality when the channel is unarchived. (Note that, as there was no playbook, the playbook actions that run when a playbook is restarted do not exist.)

Backup: Channel checklists are stored in the Mattermost database and included in standard database backups with no separate backup mechanism. (I really don't think this needs to be documented as it is just what is true across the board.)

Concurrent Editing: Multiple users can edit the same checklist simultaneously with no conflict resolution - the last save wins and users may overwrite each other's changes.

Notifications: Users receive real-time WebSocket updates when checklists are modified, but there are no specific notification preferences for checklist activities.

Limits: No limits exist on number of checklists per channel or tasks per checklist, but individual task descriptions are limited to 4,000 characters.

@cwarnermm
Copy link
Member Author

@calebroseland @JulienTant - Appreciate you verfiying @jgheithcock's AI-assisted verifications :)

@github-actions
Copy link
Contributor

github-actions bot commented Feb 3, 2026

Newest code from mattermost has been published to preview environment for Git SHA 917521b

@calebroseland
Copy link
Member

calebroseland commented Feb 3, 2026

Are there checklist permissions details to call out -- specifically around guest access: can they create checklists if they have channel post permissions?

• Guest Access: Guest users can create and manage channel checklists if they have posting permissions in the channel, but cannot access checklists from private channels they don't belong to.

Correction: as of 2.6.0, Guest users cannot create checklists in public or private channels as they cannot manage channel settings—playbooks has checked for this permission for some time. Also worth noting: regular users / channel members must have permission to manage channel settings in order to create channel checklists.
Summary:

  • to create a channel checklist, user must have permission to manage channel settings.
  • to manage or edit a channel checklist, user must have permission to post in the channel.

Future: https://mattermost.atlassian.net/browse/MM-66823 will address this to align with what JG mentioned: "Guest users can create and manage channel checklists if they have posting permissions in the channel". The change will straighten out permissions and allow any channel members with posting permissions to create and manage channel checklists.


Can a single channel have both playbook runs and channel checklists? Anything worth noting when both are present, if supported?

• Coexistence: A single channel can contain both playbook runs and standalone channel checklists simultaneously - channel members have immediate edit access to checklists but must opt-in to become participants before editing playbook runs.

Correct/confirmed.


What happens if a user loses channel access while actively working on a checklist?

• Losing Channel Access: Users who lose channel membership immediately lose all access to that channel's checklists, and any unsaved changes are lost.

Correct/confirmed.

--
4.

What happens when a channel is archived? Are those checklists available/accessible? What if the channel is unarchived?

• Channel Archival: Checklists in archived channels become read-only (viewable but not editable) and regain full functionality when the channel is unarchived. (Note that, as there was no playbook, the playbook actions that run when a playbook is restarted do not exist.)

Correct/confirmed.


What happens when a channel is archived? Are those checklists available/accessible? What if the channel is unarchived?

• Backup: Channel checklists are stored in the Mattermost database and included in standard database backups with no separate backup mechanism. (I really don't think this needs to be documented as it is just what is true across the board.)

Correct/confirmed/agreed.


Is it possible for multiple users to edit the same checklist task at the same time? Who wins? Are there safeguards in place against conflicting edits?

• Concurrent Editing: Multiple users can edit the same checklist simultaneously with no conflict resolution - the last save wins and users may overwrite each other's changes.

Add/clarify: checklists are updated in realtime, so the chances for conflicts are relatively low.


Are users notified of checklist updates?

• Notifications: Users receive real-time WebSocket updates when checklists are modified, but there are no specific notification preferences for checklist activities.

Correct/confirmed.


Is there a maximum number or upper limit to the number of checklists for a given channel?

• Limits: No limits exist on number of checklists per channel or tasks per checklist, but individual task descriptions are limited to 4,000 characters.

Correct, no limits on checklists per channel or tasks per checklist.
However, task description max length is either MaxPostSize from server config, or 4000 chars as a fallback limit.

@github-actions
Copy link
Contributor

github-actions bot commented Feb 5, 2026

Newest code from mattermost has been published to preview environment for Git SHA f6891d7

@cwarnermm
Copy link
Member Author

@calebroseland @jgheithcock - Thank you for the detailed responses. This PR is ready for your final review.

@github-actions
Copy link
Contributor

github-actions bot commented Feb 5, 2026

Newest code from mattermost has been published to preview environment for Git SHA 9759566

Copy link
Member

@calebroseland calebroseland left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, Carrie!

@github-actions
Copy link
Contributor

github-actions bot commented Feb 6, 2026

Newest code from mattermost has been published to preview environment for Git SHA d147222

@cwarnermm cwarnermm removed the request for review from jgheithcock February 6, 2026 16:55
@cwarnermm cwarnermm added 3: Reviews Complete All reviewers have approved the pull request and removed 1: Dev Review Requires review by a core commiter labels Feb 6, 2026
@cwarnermm cwarnermm merged commit 5fb0a2b into master Feb 6, 2026
4 checks passed
@cwarnermm cwarnermm deleted the claude/issue-8654-20260119-2141 branch February 6, 2026 16:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

3: Reviews Complete All reviewers have approved the pull request Guidance

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Playbooks v2.6: Checklists

3 participants