Trestle Document Governance
Trestle has three governance commands. The commands check document structure against templates. Teams can keep a standard document format. Teams can add structure validation to CI/CD pipelines.
Three Governance Commands
| Command | Scope | What It Checks |
|---|---|---|
trestle author headers |
YAML frontmatter only | Header field names, types, and required values |
trestle author docs |
Full markdown documents | Headers + document structure (headings, sections) |
trestle author folders |
Directory structure | Headers + docs + folder layout (same files in each instance) |
Four Modes
Each governance command supports four modes:
| Mode | Purpose | Example |
|---|---|---|
setup |
Create template directory and initial templates | trestle author docs setup -tn my-task |
create-sample |
Generate new instances from templates | trestle author docs create-sample -tn my-task |
template-validate |
Validate the template files themselves | trestle author docs template-validate -tn my-task |
validate |
Validate instance documents against templates | trestle author docs validate -tn my-task |
Template Location
Templates are stored in the trestle workspace under:
.trestle/author/<task-name>/
├── template.md # For docs governance
├── a_template.md # For folders governance
├── another_template.md # Additional folder templates
└── architecture.drawio # Non-markdown templates
Instance documents live at the workspace root:
<task-name>/
├── document_001.md # Created by create-sample
├── document_002.md
└── subfolder/ # For folders governance
├── a_template.md
└── another_template.md
Template Versioning
Templates use x-trestle-template-version in their YAML header to track versions:
---
x-trestle-template-version: 1.0.0
title: ""
description: ""
status: draft
---
If you set --template-version during validation, Trestle checks only documents with that template version.
You can migrate templates in steps.
Governed Headings
The -gh / --governed-heading flag requires specific markdown headings in documents:
trestle author docs validate -tn my-task -gh "Purpose" -gh "Scope"
This check requires every document under my-task/ to contain ## Purpose and ## Scope sections.
Key Flags
| Flag | Commands | Description |
|---|---|---|
-tn, --task-name |
All | Task name (maps to directory names) |
-gh, --governed-heading |
docs, folders | Required heading in documents |
-hv, --header-validate |
docs, folders | Validate YAML header structure |
-hov, --header-only-validate |
docs, folders | Only validate headers, skip body |
-r, --recurse |
headers, docs | Recurse into subdirectories |
-rv, --readme-validate |
All | Include README.md in validation |
-tv, --template-version |
All | Target specific template version |
-ig, --ignore |
All | Regex to ignore files/folders |
-g, --global |
headers | Use global template at __global__/ |
-vtt, --validate-template-type |
docs, folders | Use x-trestle-template-type field |
CI/CD Integration
Use governance commands in CI/CD pipelines. Common patterns follow.
GitHub Actions
- name: Validate compliance docs
run: |
trestle author docs validate -tn policies -hv -gh "Purpose" -gh "Scope"
trestle author headers validate -tn standards -r
Pre-commit Hook
- repo: local
hooks:
- id: trestle-docs-validate
name: Validate governed docs
entry: trestle author docs validate -tn my-task -hv
language: system
pass_filenames: false
Workflow: Setting Up Governance
Create templates:
trestle author docs setup -tn security-policiesCustomize the template at
.trestle/author/security-policies/template.md:- Add required YAML header fields.
- Add governed heading structure.
- Set
x-trestle-template-version.
Generate samples:
trestle author docs create-sample -tn security-policiesValidate:
trestle author docs validate -tn security-policies -hv -gh "Purpose"Add the check to CI/CD. Keep the check in place.
Headers vs Docs vs Folders
Choose the right governance level:
- headers: Light check. Require consistent YAML frontmatter across documents. Use this for metadata standards.
- docs: Medium check. Require headers and document structure (headings). Use this for policy documents, procedures, and runbooks.
- folders: Heavy check. Require full directory structures. Use this for system assessment packages, component evidence folders, or any case where related files must exist together.
Practical Template Example: Security Policy
Template File
Located at .trestle/author/security-policies/template.md:
---
x-trestle-template-version: 1.0.0
title: ""
status: draft
owner: ""
review-date: ""
---
# [Policy Title]
## Purpose
[Describe why this policy exists and what it aims to achieve.]
## Scope
[Describe who and what this policy applies to.]
## Policy Statement
[The actual policy requirements and mandates.]
## Enforcement
[Describe consequences for non-compliance and how the policy is enforced.]
## Exceptions
[Process for requesting exceptions and who approves them.]
Instance Document
An actual policy at security-policies/access-control-policy.md:
---
x-trestle-template-version: 1.0.0
title: Access Control Policy
status: approved
owner: Chief Information Security Officer
review-date: 2025-06-15
---
# Access Control Policy
## Purpose
This policy establishes requirements for managing access to organizational
information systems to ensure only authorized users can access sensitive
resources.
## Scope
This policy applies to all employees, contractors, and third-party users
who access organizational information systems.
## Policy Statement
All access to information systems must follow the principle of least
privilege. Users shall be granted only the minimum access necessary to
perform their job functions. Privileged access requires additional approval
from the system owner and ISSO.
## Enforcement
Violations are handled through the organizational disciplinary process.
Automated monitoring detects unauthorized access attempts and triggers
incident response procedures.
## Exceptions
Exception requests must be submitted to the ISSO with business justification.
Exceptions are reviewed quarterly and expire after 12 months unless renewed.
Validate the Structure
trestle author docs validate -tn security-policies -hv \
-gh "Purpose" -gh "Scope" -gh "Policy Statement" \
-gh "Enforcement" -gh "Exceptions"
Using Global Templates
Global templates apply organization-wide header standards across all task names.
Location: .trestle/author/__global__/
.trestle/author/
├── __global__/
│ └── template.md # Global header template
├── security-policies/
│ └── template.md # Task-specific template (extends global)
└── procedures/
└── template.md
How Global Templates Work
- The global template defines baseline YAML header fields that every document must have. Examples:
status,owner,review-date. - Task-specific templates can add additional fields on top of the global requirements.
- Validate against the global template with the
-gflag:trestle author headers validate -tn security-policies -g - Global plus task-specific validation runs both checks:
trestle author headers validate -tn security-policies -g trestle author docs validate -tn security-policies -hv -gh "Purpose"
You can require organization-wide metadata. Each document type can still have its own structure rules.
Template Migration
When templates change, use template versioning. Example: you add a required heading or header field.
Migration Steps
Update the template with the new requirements and bump the version:
--- x-trestle-template-version: 2.0.0 # was 1.0.0 title: "" status: draft owner: "" review-date: "" risk-level: "" # new required field ---Add the new governed heading (if applicable):
## Risk Assessment [New required section for v2.0.0]Validate old documents against the old version (existing documents still pass):
trestle author docs validate -tn security-policies -hv --template-version 1.0.0Migrate documents in steps. Update each document to the v2.0.0 format. Add the new field and section. Then change
x-trestle-template-versionto2.0.0.Validate migrated documents against the new version:
trestle author docs validate -tn security-policies -hv --template-version 2.0.0Drop the old version after all documents migrate. Remove the
--template-versionflag. Trestle then validates all documents against the current template.
Governed Folder Example: Assessment Package
Governed folders require every instance of a folder-based document package to use the same structure.
Template Structure
.trestle/author/assessment-evidence/
├── overview.md
├── test-results.md
└── screenshots/
└── placeholder.md
Instance Folders
Each assessment creates a folder matching this structure:
assessment-evidence/
├── 2024-q1-assessment/
│ ├── overview.md
│ ├── test-results.md
│ └── screenshots/
│ └── placeholder.md
├── 2024-q3-assessment/
│ ├── overview.md
│ ├── test-results.md
│ └── screenshots/
│ └── placeholder.md
Setup and Validation
# Set up the governed folder template
trestle author folders setup -tn assessment-evidence
# Create a new instance from the template
trestle author folders create-sample -tn assessment-evidence -on 2025-q1-assessment
# Validate all instances have the required structure
trestle author folders validate -tn assessment-evidence -hv
Validation checks each instance folder. Each folder must contain all template files. Those files must match the template headers and governed headings.
Cross-References
- trestle-control-implementation: SSP control markdown follows trestle-governed header conventions for parameters and rules.
- trestle-validation: Combine governance structure validation with OSCAL schema validation.
- trestle-authoring-workflow: Add governance validation to the generate and assemble CI/CD pipeline.