Skip to content

Migrated documentation build script to GitHub actions #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
tholzheim wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Migrated documentation build script to GitHub actions #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ff04dd4
updates dtcw script to version v3.4.2
tholzheim Dec 3, 2025
dce92c4
adds buildDocs workflow
tholzheim Dec 3, 2025
178b9a5
changed permission of dtcw script to executable
tholzheim Dec 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions .github/workflows/buildDocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
name: Run docToolchain

on:
push:
branches:
- main


jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Check out code
uses: actions/checkout@v5
with:
lfs: true

- name: Generate HTML Documentation
run: |
cd ./federated-catalogue
./dtcw generateHTML

- name: Generate PDF Documentation
run: |
cd ./federated-catalogue
./dtcw generatePDF
Comment on lines +21 to +26
Copy link

Copilot AI Dec 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nitpick] The workflow runs dtcw script without explicitly setting up Java or specifying the execution environment. The dtcw script will default to 'local' environment which requires Java 11-17. Consider either:

  1. Adding a Java setup step before generating documentation (e.g., actions/setup-java@v4), or
  2. Explicitly using the docker environment by changing the commands to ./dtcw docker generateHTML and ./dtcw docker generatePDF

Option 2 is recommended as it ensures a consistent build environment without requiring Java installation.

Suggested change
./dtcw generateHTML
- name: Generate PDF Documentation
run: |
cd ./federated-catalogue
./dtcw generatePDF
./dtcw docker generateHTML
- name: Generate PDF Documentation
run: |
cd ./federated-catalogue
./dtcw docker generatePDF

Copilot uses AI. Check for mistakes.

- name: Upload Artifacts
uses: actions/upload-artifact@v4
with:
name: Documentation
path: |
federated-catalogue/build/pdf/architecture/catalogue-architecture.pdf
federated-catalogue/build/html5/
Loading