PDF Not Being Generated When Running DITA-OT Docker Container in GitHub Actions Workflow

[IbrahimBhatty-Emumba]

In my GitHub Actions workflow, I'm attempting to generate PDF files using a Docker container with DITA-OT. While the workflow runs without errors, the PDF files are not being generated as expected, and the logs are also empty. Here's a detailed description of the issue:

Despite configuring the GitHub Actions workflow to run a Docker container with DITA-OT for PDF generation, the PDF files are not being generated. After the workflow execution, the out directory, where the PDF files are supposed to be stored, remains empty. Additionally, the logs generated by the workflow do not contain any error messages or indications of the PDF generation process.

This is my workflow file:

name: CI
'on':
  push:
    branches:
      - master
      - main
jobs:
  build-dita:
    name: Build DITA
    runs-on: ubuntu-latest
    steps:

      # - name: Install JDK 11
      #   run: sudo apt-get install -y openjdk-11-jdk

      # - name: Install JDK 8 Development Package
      #   run: sudo apt-get install -y openjdk-8-jdk openjdk-8-jdk-headless

      # - name: Set Java 8 as Default
      #   run: sudo update-alternatives --set java /usr/lib/jvm/java-8-openjdk-amd64/jre/bin/java

      - name: Git checkout
        uses: actions/checkout@v2

      - name: List directory contents
        run: ls -al

      # - name: Build PDF
      #   uses: dita-ot/dita-ot-action@master
      #   with:
      #     input: sequence.ditamap
      #     transtype: pdf
      #     output-path: out

      # - name: Build PDF using DITA-OT 3.5.4
      #   uses: dita-ot/dita-ot-action@master
      #   with:
      #       dita-ot-version: 3.5.4
      #       input: 'sequence.ditamap'
      #       transtype: 'pdf'
      #       properties: '--filter=pdf.ditaval'
      #       output-path: .
      - name: Build PDF using DITA-OT Docker image
        run: docker run --rm -v ${{ github.workspace }}:/workspace ditaot/dita-ot:latest dita --input=/workspace/sequence.ditamap --format=pdf2 -o /workspace
      
      # - name: Display log
      #   run: cat dita_output.log

      - name: Upload PDF
        uses: actions/upload-artifact@v2
        with:
          name: generated-pdf
          path: out/*.pdf

I have tried to troubleshoot this to the best of my ability but to no avail. Do let me know if you need any other details that could help in identifying the issue.

Thank you for your assistance and expertise!

[jelovirt]

The ditaot/dita-ot Docker image is not owned or maintained by the DITA-OT project. I think that Docker image is maintained by https://www.dita4publishers.org/.

The DITA-OT project only has Docker images at https://github.com/dita-ot/dita-ot/pkgs/container/dita-ot.

[IbrahimBhatty-Emumba]

Thank you @jelovirt for your reply. I have changed the image to the proper one and am now getting this error

Error:  Anttask - Error rendering fo file: /tmp/temp20240529105413903/topic.fo <Failed to open /workspace/sequence.pdf>Failed to open /workspace/sequence.pdf
	at org.apache.fop.tools.anttasks.FOPTaskStarter.renderInputHandler(Fop.java:643)
	at org.apache.fop.tools.anttasks.FOPTaskStarter.render(Fop.java:671)
	at org.apache.fop.tools.anttasks.FOPTaskStarter.run(Fop.java:[53](https://github.com/IbrahimBhatty-Emumba/Dita-Github-Actions-POC/actions/runs/9284813944/job/25547991053#step:4:54)2)
	at org.apache.fop.tools.anttasks.Fop.execute(Fop.java:369)
	at org.apache.tools.ant.UnknownElement.execute(UnknownElement.java:299)
	at jdk.internal.reflect.GeneratedMethodAccessor6.invoke(Unknown Source)
	at java.base/jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(Unknown Source)
	at java.base/java.lang.reflect.Method.invoke(Unknown Source)
	at org.apache.tools.ant.dispatch.DispatchUtils.execute(DispatchUtils.java:99)
	at org.apache.tools.ant.Task.perform(Task.java:350)
	at org.apache.tools.ant.Target.execute(Target.java:449)
	at org.apache.tools.ant.Target.performTasks(Target.java:470)
	at org.apache.tools.ant.Project.executeSortedTargets(Project.java:1401)
	at org.apache.tools.ant.helper.SingleCheckExecutor.executeTargets(SingleCheckExecutor.java:36)
	at org.apache.tools.ant.Project.executeTargets(Project.java:12[64](https://github.com/IbrahimBhatty-Emumba/Dita-Github-Actions-POC/actions/runs/9284813944/job/25547991053#step:4:65))
	at org.apache.tools.ant.taskdefs.Ant.execute(Ant.java:437)
	at org.apache.tools.ant.taskdefs.CallTarget.execute(CallTarget.java:106)
	at org.apache.tools.ant.UnknownElement.execute(UnknownElement.java:299)
	at jdk.internal.reflect.GeneratedMethodAccessor6.invoke(Unknown Source)
	at java.base/jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(Unknown Source)
	at java.base/java.lang.reflect.Method.invoke(Unknown Source)
	at org.apache.tools.ant.dispatch.DispatchUtils.execute(DispatchUtils.java:99)
	at org.apache.tools.ant.Task.perform(Task.java:350)
	at org.apache.tools.ant.Target.execute(Target.java:449)
	at org.apache.tools.ant.Target.performTasks(Target.java:4[70](https://github.com/IbrahimBhatty-Emumba/Dita-Github-Actions-POC/actions/runs/9284813944/job/25547991053#step:4:71))
	at org.apache.tools.ant.Project.executeSortedTargets(Project.java:1401)
	at org.apache.tools.ant.helper.SingleCheckExecutor.executeTargets(SingleCheckExecutor.java:36)
	at org.apache.tools.ant.Project.executeTargets(Project.java:1264)
	at org.apache.tools.ant.taskdefs.Ant.execute(Ant.java:437)
	at org.apache.tools.ant.taskdefs.CallTarget.execute(CallTarget.java:106)
	at org.apache.tools.ant.UnknownElement.execute(UnknownElement.java:299)
	at jdk.internal.reflect.GeneratedMethodAccessor6.invoke(Unknown Source)
	at java.base/jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(Unknown Source)
	at java.base/java.lang.reflect.Method.invoke(Unknown Source)
	at org.apache.tools.ant.dispatch.DispatchUtils.execute(DispatchUtils.java:99)
	at org.apache.tools.ant.Task.perform(Task.java:350)
	at org.apache.tools.ant.Target.execute(Target.java:449)
	at org.apache.tools.ant.Target.performTasks(Target.java:470)
	at org.apache.tools.ant.Project.executeSortedTargets(Project.java:1401)
	at org.apache.tools.ant.Project.executeTarget(Project.java:13[74](https://github.com/IbrahimBhatty-Emumba/Dita-Github-Actions-POC/actions/runs/9284813944/job/25547991053#step:4:75))
	at org.apache.tools.ant.helper.DefaultExecutor.executeTargets(DefaultExecutor.java:41)
	at org.apache.tools.ant.Project.executeTargets(Project.java:1264)
	at org.dita.dost.invoker.Main.runBuild(Main.java:853)
	at org.dita.dost.invoker.Main.startAnt(Main.java:240)
	at org.apache.tools.ant.launch.Launcher.run(Launcher.java:284)
	at org.apache.tools.ant.launch.Launcher.main(Launcher.java:101)
Caused by: java.io.FileNotFoundException: /workspace/sequence.pdf (Permission denied)
	at java.base/java.io.FileOutputStream.open0(Native Method)
	at java.base/java.io.FileOutputStream.open(Unknown Source)
	at java.base/java.io.FileOutputStream.<init>(Unknown Source)
	at java.base/java.io.FileOutputStream.<init>(Unknown Source)
	at org.apache.fop.tools.anttasks.FOPTaskStarter.renderInputHandler(Fop.java:640)
	... 45 more
Error: Build failed with an exception: [PDFX013F] The PDF file '/workspace/sequence.pdf' cannot be generated.

What I have surmised from this is that the docker container does not have permission to write to the specified directory. Any idea on how I can give it that permission?

[IbrahimBhatty-Emumba]

Okay so I resolved it by running the docker command as a root user. Now once again my workflow is successful but the pdf is not being generated and no errors are being thrown
This the command I am running now :

- name: Build PDF using DITA-OT Docker image
  run: docker run --rm --user root -v ${{ github.workspace }}:/workspace ghcr.io/dita-ot/dita-ot:4.2.3 --input=/workspace/sequence.ditamap --format=pdf2 -o /workspace

[jelovirt]

@IbrahimBhatty-Emumba Could run with -v or -d flag to get some more logging data.