modernize the actions and add citation boilerplate

.github/workflows/manual.yml

@@ -0,0 +1,23 @@
+# Render the document on-demand. This can be useful for producing one-off diffs.
+
+name: Render (Manual)
+
+on:
+  workflow_dispatch:
+    inputs:
+      revision:
+        description: the version or commit to render (if left empty, uses default branch)
+        required: false
+        type: string
+      diffbase:
+        description: the version or commit to diff against (if left empty, no diff is generated)
+        required: false
+        type: string
+
+jobs:
+  render:
+    uses: ./.github/workflows/render.yml
+    with:
+      workflow: manual
+      revision: ${{ inputs.revision }}
+      manual_diffbase: ${{ inputs.diffbase }}

.github/workflows/pr.yml

@@ -0,0 +1,12 @@
+# Render the document on pull requests.
+
+name: Render (Pull Request)
+
+on:
+  pull_request:
+
+jobs:
+  render:
+    uses: ./.github/workflows/render.yml
+    with:
+      workflow: pr

.github/workflows/push.yml

@@ -0,0 +1,14 @@
+# Render the document on pushes to main.
+
+name: Render (Push)
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  render-all-parts:
+    uses: ./.github/workflows/render.yml
+    with:
+      workflow: push

.github/workflows/release.yml

@@ -0,0 +1,12 @@
+# Render the document on releases.
+
+name: Render (Release)
+
+on:
+  release:
+
+jobs:
+  render-all-parts:
+    uses: ./.github/workflows/render.yml
+    with:
+      workflow: release

.github/workflows/render.yml

@@ -0,0 +1,36 @@
+# Reusable workflow to render the spec.
+# https://docs.github.com/en/actions/using-workflows/reusing-workflows
+
+name: Render
+
+on:
+  workflow_call:
+    inputs:
+      workflow:
+        description: the workflow to run ('pr', 'push', 'release', 'manual')
+        required: true
+        type: string
+      revision:
+        description: version to render (default is default branch)
+        required: false
+        type: string
+      manual_diffbase:
+        description: diffbase for manual workflow
+        required: false
+        type: string
+
+jobs:
+  render:
+    # When updating the version of the Pandoc toolset, update the
+    # container-version below as well.
+    uses: trustedcomputinggroup/pandoc/.github/workflows/render.yml@v0.18.14
+    with:
+      container-version: 0.18.14
+      # When renaming the file in the repository, change it here as well.
+      # For a project containing multiple parts, it may be useful to create
+      # a "render all" reusable workflow that passes each file to this workflow
+      # as an additional "input" parameter.
+      input: document.tcg
+      workflow: ${{ inputs.workflow }}
+      revision: ${{ inputs.revision }}
+      manual_diffbase: ${{ inputs.manual_diffbase }}

bibliography.yml

@@ -0,0 +1,8 @@
+references:
+  - id: "alg-registry"
+    title: "TCG Algorithm Registry"
+    publisher: "Trusted Computing Group"
+    issued:
+      year: 2025
+      month: 2
+    url: "https://trustedcomputinggroup.org/resource/tcg-algorithm-registry/"

spec.tcg → document.tcg

@@ -1,24 +1,26 @@
 ---
 title: "Document Title"
 type: SPECIFICATION
+bibliography: bibliography.yml
+csl: ieee.csl
 ...
 
 ---
 
 # Disclaimers, Notices, and License Terms
 
-THIS SPECIFICATION IS PROVIDED "AS IS" WITH NO WARRANTIES WHATSOEVER, INCLUDING
+THIS DOCUMENT IS PROVIDED "AS IS" WITH NO WARRANTIES WHATSOEVER, INCLUDING
 ANY WARRANTY OF MERCHANTABILITY, NONINFRINGEMENT, FITNESS FOR ANY PARTICULAR
-PURPOSE, OR ANY WARRANTY OTHERWISE ARISING OUT OF ANY PROPOSAL, SPECIFICATION OR
+PURPOSE, OR ANY WARRANTY OTHERWISE ARISING OUT OF ANY PROPOSAL, DOCUMENT OR
 SAMPLE.
 
 Without limitation, TCG disclaims all liability, including liability for
 infringement of any proprietary rights, relating to use of information in this
-specification and to the implementation of this specification, and TCG disclaims
+document and to the implementation of this document, and TCG disclaims
 all liability for cost of procurement of substitute goods or services, lost
 profits, loss of use, loss of data or any incidental, consequential, direct,
 indirect, or special damages, whether under contract, tort, warranty or
-otherwise, arising in any way out of use or reliance upon this specification or
+otherwise, arising in any way out of use or reliance upon this document or
 any information herein.
 
 This document is copyrighted by Trusted Computing Group (TCG), and no license,
@@ -43,6 +45,9 @@ owners.
 **Version** **Date**   **Description**
 ----------- ---------- ---------------------------------------------------------
 0.1         2024/01/29 Initial draft
+
+1.0         2025/11/19 Streamlined GitHub actions and included IEEE citation
+                       boilerplate files.
 --------------------------------------------------------------------------------
 
 # Document Style
@@ -92,12 +97,16 @@ Reach out to <admin@trustedcomputinggroup> with any questions about this documen
   * Require approvals
   * Do not allow bypassing the above settings
   * (Optional) Require review from Code Owners (Requires setting up CODEOWNERS file)
-* (Optional) rename spec.md and update all references in `actions.yml`
+* (Optional) rename document.md and update all references in `render.yml`
 * Check for newer [pandoc](https://github.com/trustedcomputinggroup/pandoc) and
   [markdown](https://github.com/trustedcomputinggroup/markdown) action versions
-  for `actions.yml`
-* Update the document title and type in the YAML front matter
+  for `render.yml`
+* Update the document title and type (SPECIFICATION, GUIDANCE, or REFERENCE) in
+  the YAML front matter
 * (Optional) Do an initial release to set baseline version (e.g., if migrating
   from an existing Word doc).
 * (Optional) Review the guidance about release naming in the latest User's
-  Guide from <https://github.com/trustedcomputinggroup/pandoc>.
+  Guide from <https://github.com/trustedcomputinggroup/pandoc>.
+* (Optional) Customize the citation style if IEEE is not preferred.
+* (Optional) For a document with no references, remove the `bibliography` and
+  `csl` from the YAML front matter instead.