Skip to content

Commit 0806f4a

Browse files
committed
Update CI steps
1 parent 2ff3703 commit 0806f4a

File tree

2 files changed

+13
-12
lines changed

2 files changed

+13
-12
lines changed

.github/workflows/build_docs.yml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -26,15 +26,15 @@ jobs:
2626
- name: Upload PDF artifact
2727
uses: actions/upload-artifact@v4
2828
with:
29-
name: aousd_core_spec
30-
path: tests/build/aousd_core_spec.pdf
29+
name: aousd_doc_build
30+
path: tests/build/aousd_doc_build.pdf
3131
- name: Upload DOCX artifact
3232
uses: actions/upload-artifact@v4
3333
with:
34-
name: aousd_core_spec-docx
35-
path: tests/build/aousd_core_spec.docx
34+
name: aousd_doc_build-docx
35+
path: tests/build/aousd_doc_build.docx
3636
- name: Upload HTML artifact
3737
uses: actions/upload-artifact@v4
3838
with:
39-
name: aousd_core_spec-html
40-
path: tests/build/aousd_core_spec.html
39+
name: aousd_doc_build-html
40+
path: tests/build/aousd_doc_build.html

README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,7 @@ Dependencies are automatically installed by [pixi](https://pixi.sh), and should
111111

112112
To automate CI in your specifications repo, add the following at `.github/workflows/build_docs.yml`
113113

114+
But replace `<DOCUMENT_NAME>` with your documents output name
114115

115116
```yaml
116117
name: build_docs.yml
@@ -141,18 +142,18 @@ jobs:
141142
- name: Upload PDF artifact
142143
uses: actions/upload-artifact@v4
143144
with:
144-
name: aousd_core_spec
145-
path: build/aousd_core_spec.pdf
145+
name: <DOCUMENT_NAME>
146+
path: build/<DOCUMENT_NAME>.pdf
146147
- name: Upload DOCX artifact
147148
uses: actions/upload-artifact@v4
148149
with:
149-
name: aousd_core_spec-docx
150-
path: build/aousd_core_spec.docx
150+
name: <DOCUMENT_NAME>-docx
151+
path: build/<DOCUMENT_NAME>.docx
151152
- name: Upload HTML artifact
152153
uses: actions/upload-artifact@v4
153154
with:
154-
name: aousd_core_spec-html
155-
path: build/aousd_core_spec.html
155+
name: <DOCUMENT_NAME>-html
156+
path: build/<DOCUMENT_NAME>.html
156157
```
157158

158159
This will run on every PR update and upload the artifacts for you to download

0 commit comments

Comments
 (0)