Skip to content

Commit 55dfc35

Browse files
committed
update latest pandoc and spec guidance
1 parent d639db2 commit 55dfc35

2 files changed

Lines changed: 44 additions & 21 deletions

File tree

.github/workflows/actions.yml

Lines changed: 36 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,39 +12,68 @@ jobs:
1212
render:
1313
runs-on: ubuntu-latest
1414
container:
15-
image: ghcr.io/trustedcomputinggroup/pandoc:0.8.2
15+
image: ghcr.io/trustedcomputinggroup/pandoc:0.10.2
1616
name: Render PDF
1717
steps:
1818
- name: Checkout
1919
uses: actions/checkout@v3
20+
with:
21+
fetch-depth: 0
22+
fetch-tags: true
23+
24+
- name: Cache LaTeX files
25+
uses: actions/cache@v3
26+
env:
27+
cache-name: cache-latex-files
28+
with:
29+
path: |
30+
*.aux
31+
*.fdb_latexmk
32+
*.lof
33+
*.lot
34+
*.toc
35+
*.convert.pdf
36+
key: latex-${{ github.run_id }}
37+
restore-keys: latex
2038

2139
- name: Render
2240
uses: trustedcomputinggroup/markdown@v0.4.2
2341
with:
2442
input-md: spec.md
43+
extra-build-options: "--versioned_filenames"
2544
output-pdf: spec.pdf
2645
output-docx: spec.docx
2746

2847
- name: Upload PDF to PR
2948
uses: actions/upload-artifact@master
3049
if: ${{ github.event_name == 'pull_request' }}
3150
with:
32-
name: spec.pdf
33-
path: spec.pdf
51+
name: PDF
52+
path: spec.*.pdf
3453

3554
- name: Upload Word to PR
3655
uses: actions/upload-artifact@master
3756
if: ${{ github.event_name == 'pull_request' }}
3857
with:
39-
name: spec.docx
40-
path: spec.docx
58+
name: Word
59+
path: spec.*.docx
60+
61+
- name: Upload PDF to release
62+
uses: svenstaro/upload-release-action@v2
63+
if: ${{ github.event_name == 'release' }}
64+
with:
65+
repo_token: ${{ secrets.GITHUB_TOKEN }}
66+
file: spec.*.pdf
67+
tag: ${{ github.ref }}
68+
overwrite: true
69+
file_glob: true
4170

42-
- name: Upload PDF and docx to release
71+
- name: Upload Word to release
4372
uses: svenstaro/upload-release-action@v2
4473
if: ${{ github.event_name == 'release' }}
4574
with:
4675
repo_token: ${{ secrets.GITHUB_TOKEN }}
47-
file: spec.*
76+
file: spec.*.docx
4877
tag: ${{ github.ref }}
4978
overwrite: true
5079
file_glob: true

spec.md

Lines changed: 8 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -68,17 +68,9 @@ comment_, it can be considered a _normative statement_.
6868

6969
EXAMPLE:
7070

71-
::: Informative :::
72-
This is the first paragraph of 1–n paragraphs containing text of the kind
73-
informative comment ...
74-
75-
This is the second paragraph of text of the kind informative comment ...
76-
77-
This is the nth paragraph of text of the kind informative comment ...
78-
79-
To understand the TCG specification, the user must read the specification.
80-
(This use of MUST does not require any action).
81-
:::::::::::::::::::
71+
::: Informative ::::
72+
Reach out to <admin@trustedcomputinggroup> with any questions about this document.
73+
::::::::::::::::::::
8274

8375
---
8476

@@ -93,7 +85,8 @@ To understand the TCG specification, the user must read the specification.
9385
# Checklist for users of this template
9486

9587
* Ensure the repository is set to private
96-
* Add the correct GitHub team(s) to Collaborators* Add TCGadmin to Admin
88+
* Add the correct GitHub team(s) to Collaborators
89+
* Add TCGadmin to Admin
9790
* Add a branch protection rule on `main`
9891
* Require a pull request before merging
9992
* Require approvals
@@ -104,6 +97,7 @@ To understand the TCG specification, the user must read the specification.
10497
[markdown](https://github.com/trustedcomputinggroup/markdown) action versions
10598
for `actions.yml`
10699
* Update the document title and type in the YAML front matter
107-
* For GUIDANCE or REFERENCE docs, add `template: bluetop`
108100
* (Optional) Do an initial release to set baseline version (e.g., if migrating
109-
from an existing Word doc).
101+
from an existing Word doc).
102+
* (Optional) Review the guidance about release naming in the latest User's
103+
Guide from <https://github.com/trustedcomputinggroup/pandoc>.

0 commit comments

Comments
 (0)