Skip to content

Commit ee93bb9

Browse files
chrisfennerchrisfenner
authored
Merge pull request #10 from TrustedComputingGroup/update-template-modern-actions
modernize the actions and add citation boilerplate
2 parents 9ff3191 + 78c5c79 commit ee93bb9

File tree

9 files changed

+634
-87
lines changed

9 files changed

+634
-87
lines changed

‎.github/workflows/actions.yml‎

Lines changed: 0 additions & 79 deletions
This file was deleted.

‎.github/workflows/manual.yml‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Render the document on-demand. This can be useful for producing one-off diffs.
2+
3+
name: Render (Manual)
4+
5+
on:
6+
workflow_dispatch:
7+
inputs:
8+
revision:
9+
description: the version or commit to render (if left empty, uses default branch)
10+
required: false
11+
type: string
12+
diffbase:
13+
description: the version or commit to diff against (if left empty, no diff is generated)
14+
required: false
15+
type: string
16+
17+
jobs:
18+
render:
19+
uses: ./.github/workflows/render.yml
20+
with:
21+
workflow: manual
22+
revision: ${{ inputs.revision }}
23+
manual_diffbase: ${{ inputs.diffbase }}

‎.github/workflows/pr.yml‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Render the document on pull requests.
2+
3+
name: Render (Pull Request)
4+
5+
on:
6+
pull_request:
7+
8+
jobs:
9+
render:
10+
uses: ./.github/workflows/render.yml
11+
with:
12+
workflow: pr

‎.github/workflows/push.yml‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Render the document on pushes to main.
2+
3+
name: Render (Push)
4+
5+
on:
6+
push:
7+
branches:
8+
- main
9+
10+
jobs:
11+
render-all-parts:
12+
uses: ./.github/workflows/render.yml
13+
with:
14+
workflow: push

‎.github/workflows/release.yml‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Render the document on releases.
2+
3+
name: Render (Release)
4+
5+
on:
6+
release:
7+
8+
jobs:
9+
render-all-parts:
10+
uses: ./.github/workflows/render.yml
11+
with:
12+
workflow: release

‎.github/workflows/render.yml‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Reusable workflow to render the spec.
2+
# https://docs.github.com/en/actions/using-workflows/reusing-workflows
3+
4+
name: Render
5+
6+
on:
7+
workflow_call:
8+
inputs:
9+
workflow:
10+
description: the workflow to run ('pr', 'push', 'release', 'manual')
11+
required: true
12+
type: string
13+
revision:
14+
description: version to render (default is default branch)
15+
required: false
16+
type: string
17+
manual_diffbase:
18+
description: diffbase for manual workflow
19+
required: false
20+
type: string
21+
22+
jobs:
23+
render:
24+
# When updating the version of the Pandoc toolset, update the
25+
# container-version below as well.
26+
uses: trustedcomputinggroup/pandoc/.github/workflows/[email protected]
27+
with:
28+
container-version: 0.18.14
29+
# When renaming the file in the repository, change it here as well.
30+
# For a project containing multiple parts, it may be useful to create
31+
# a "render all" reusable workflow that passes each file to this workflow
32+
# as an additional "input" parameter.
33+
input: document.tcg
34+
workflow: ${{ inputs.workflow }}
35+
revision: ${{ inputs.revision }}
36+
manual_diffbase: ${{ inputs.manual_diffbase }}

‎bibliography.yml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
references:
2+
- id: "alg-registry"
3+
title: "TCG Algorithm Registry"
4+
publisher: "Trusted Computing Group"
5+
issued:
6+
year: 2025
7+
month: 2
8+
url: "https://trustedcomputinggroup.org/resource/tcg-algorithm-registry/"

spec.tcg renamed to document.tcg

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,26 @@
11
---
22
title: "Document Title"
33
type: SPECIFICATION
4+
bibliography: bibliography.yml
5+
csl: ieee.csl
46
...
57

68
---
79

810
# Disclaimers, Notices, and License Terms
911

10-
THIS SPECIFICATION IS PROVIDED "AS IS" WITH NO WARRANTIES WHATSOEVER, INCLUDING
12+
THIS DOCUMENT IS PROVIDED "AS IS" WITH NO WARRANTIES WHATSOEVER, INCLUDING
1113
ANY WARRANTY OF MERCHANTABILITY, NONINFRINGEMENT, FITNESS FOR ANY PARTICULAR
12-
PURPOSE, OR ANY WARRANTY OTHERWISE ARISING OUT OF ANY PROPOSAL, SPECIFICATION OR
14+
PURPOSE, OR ANY WARRANTY OTHERWISE ARISING OUT OF ANY PROPOSAL, DOCUMENT OR
1315
SAMPLE.
1416

1517
Without limitation, TCG disclaims all liability, including liability for
1618
infringement of any proprietary rights, relating to use of information in this
17-
specification and to the implementation of this specification, and TCG disclaims
19+
document and to the implementation of this document, and TCG disclaims
1820
all liability for cost of procurement of substitute goods or services, lost
1921
profits, loss of use, loss of data or any incidental, consequential, direct,
2022
indirect, or special damages, whether under contract, tort, warranty or
21-
otherwise, arising in any way out of use or reliance upon this specification or
23+
otherwise, arising in any way out of use or reliance upon this document or
2224
any information herein.
2325

2426
This document is copyrighted by Trusted Computing Group (TCG), and no license,
@@ -43,6 +45,9 @@ owners.
4345
**Version** **Date** **Description**
4446
----------- ---------- ---------------------------------------------------------
4547
0.1 2024/01/29 Initial draft
48+
49+
1.0 2025/11/19 Streamlined GitHub actions and included IEEE citation
50+
boilerplate files.
4651
--------------------------------------------------------------------------------
4752

4853
# Document Style
@@ -92,12 +97,16 @@ Reach out to <admin@trustedcomputinggroup> with any questions about this documen
9297
* Require approvals
9398
* Do not allow bypassing the above settings
9499
* (Optional) Require review from Code Owners (Requires setting up CODEOWNERS file)
95-
* (Optional) rename spec.md and update all references in `actions.yml`
100+
* (Optional) rename document.md and update all references in `render.yml`
96101
* Check for newer [pandoc](https://github.com/trustedcomputinggroup/pandoc) and
97102
[markdown](https://github.com/trustedcomputinggroup/markdown) action versions
98-
for `actions.yml`
99-
* Update the document title and type in the YAML front matter
103+
for `render.yml`
104+
* Update the document title and type (SPECIFICATION, GUIDANCE, or REFERENCE) in
105+
the YAML front matter
100106
* (Optional) Do an initial release to set baseline version (e.g., if migrating
101107
from an existing Word doc).
102108
* (Optional) Review the guidance about release naming in the latest User's
103-
Guide from <https://github.com/trustedcomputinggroup/pandoc>.
109+
Guide from <https://github.com/trustedcomputinggroup/pandoc>.
110+
* (Optional) Customize the citation style if IEEE is not preferred.
111+
* (Optional) For a document with no references, remove the `bibliography` and
112+
`csl` from the YAML front matter instead.

0 commit comments

Comments
 (0)