Build 'tool' doesnt seem to run (GPG sign output PDFs)

[Awbmilne]

Describe the bug

I have configured LaTeX workshop to have another build recipe that runs latexmk and then GPG to sign the output PDF. The latexmk stage runs fine, but the GPG stage seems to hang.

To Reproduce

I have used the recipe and tool settings below:

"latex-workshop.latex.recipes": [
        {
            "name": "latexmk",
            "tools": [
                "latexmk"
            ]
        },
        {
            "name": "latexmk + sign",
            "tools": [
                "latexmk",
                "signpdf"
            ]
        },
],
"latex-workshop.latex.tools": [
        {
           "args": [
                "-synctex=1",
                "-interaction=nonstopmode",
                "-file-line-error",
                "-pdf",
                "-outdir=%OUTDIR%",
                "%DOC%"
            ],
            "command": "latexmk",
            "env": {},
            "name": "latexmk"
        },
        {
            "args": [
                "--clearsign",
                "--not-dash-escaped",
                "--output=%OUTDIR%/%DOCFILE%_signed.pdf",
                "%OUTDIR%/%DOCFILE%.pdf"
            ],
            "command": "gpg",
            "env": {},
            "name": "signpdf"
        }

Expected behavior

Since I am using a hardware security key with GPG, I should expect that when running the LaTeXmk + sign recipe, the latex file will be built and then gpg will be called to sign it. This will result in a popup window for the hardware key pin, entering the pin should then allow GPG to create a signed version of the pdf file and GPG will exit with code 0, telling LaTeX workshop everything is fine.

Logs

LaTeX Workshop Output

[14:38:30] RECIPES command invoked.
[14:38:30] BUILD command invoked.
[14:38:30] The document of the active editor: file:///c:/Users/awbmilne/Documents/School/Coop Reports/2021 Fall Report/Work_Term_Report.tex
[14:38:30] The languageId of the document: latex
[14:38:30] Current workspace folders: ["file:///c:/Users/awbmilne/Documents/School/Coop Reports/2021 Fall Report"]
[14:38:30] Current workspaceRootDir: file:///c:/Users/awbmilne/Documents/School/Coop Reports/2021 Fall Report
[14:38:30] Found root file from active editor: c:\Users\awbmilne\Documents\School\Coop Reports\2021 Fall Report\Work_Term_Report.tex
[14:38:30] Keep using the same root file: c:\Users\awbmilne\Documents\School\Coop Reports\2021 Fall Report\Work_Term_Report.tex
[14:38:30] Building root file: c:\Users\awbmilne\Documents\School\Coop Reports\2021 Fall Report\Work_Term_Report.tex
[14:38:30] Build root file c:\Users\awbmilne\Documents\School\Coop Reports\2021 Fall Report\Work_Term_Report.tex
[14:38:30] outDir: c:/Users/awbmilne/Documents/School/Coop Reports/2021 Fall Report/out
[14:38:30] Recipe step 1: latexmk, --max-print-line=10000,-synctex=1,-interaction=nonstopmode,-file-line-error,-pdf,-outdir=c:/Users/awbmilne/Documents/School/Coop Reports/2021 Fall Report/out,c:/Users/awbmilne/Documents/School/Coop Reports/2021 Fall Report/Work_Term_Report
[14:38:30] Recipe step env: {}
[14:38:30] cwd: c:\Users\awbmilne\Documents\School\Coop Reports\2021 Fall Report
[14:38:30] LaTeX build process spawned. PID: 14872.
[14:38:32] Manager.fileWatcher.getWatched: {"c:\\Users\\awbmilne\\Documents\\School\\Coop Reports\\2021 Fall Report":["Work_Term_Report.tex","macros.tex"],"c:\\Users\\awbmilne\\Documents\\School\\Coop Reports\\2021 Fall Report\\ladder_diagrams":["shared_ladder.tex"],"c:\\Users\\awbmilne\\Documents\\School\\Coop Reports\\2021 Fall Report\\resources":["UWaterloo_Mechanical_Mechatronics_Eng_Logo_horiz_rgb.png"]}
[14:38:32] Manager.filesWatched: ["c:\\Users\\awbmilne\\Documents\\School\\Coop Reports\\2021 Fall Report\\Work_Term_Report.tex","c:\\Users\\awbmilne\\Documents\\School\\Coop Reports\\2021 Fall Report\\macros.tex","c:\\Users\\awbmilne\\Documents\\School\\Coop Reports\\2021 Fall Report\\ladder_diagrams\\shared_ladder.tex","c:\\Users\\awbmilne\\Documents\\School\\Coop Reports\\2021 Fall Report\\resources\\UWaterloo_Mechanical_Mechatronics_Eng_Logo_horiz_rgb.png"]
[14:38:32] BibWatcher.bibWatcher.getWatched: {}
[14:38:32] BibWatcher.bibsWatched: []
[14:38:32] PdfWatcher.pdfWatcher.getWatched: {"c:\\Users\\awbmilne\\Documents\\School\\Coop Reports\\2021 Fall Report":[],"c:\\Users\\awbmilne\\Documents\\School\\Coop Reports":["2021 Fall Report"],"c:\\Users\\awbmilne\\Documents\\School\\Coop Reports\\2021 Fall Report\\out":["Work_Term_Report_signed.pdf"]}
[14:38:32] PdfWatcher.pdfsWatched: ["c:\\Users\\awbmilne\\Documents\\School\\Coop Reports\\2021 Fall Report\\out\\Work_Term_Report_signed.pdf","c:\\Users\\awbmilne\\Documents\\School\\Coop Reports\\2021 Fall Report\\signed.pdf"]
[14:38:42] LaTeX log parsed with 4 messages.
[14:38:42] A step in recipe finished. PID: 14872.
[14:38:42] Recipe step 2: gpg, --clearsign,--not-dash-escaped,--output=c:/Users/awbmilne/Documents/School/Coop Reports/2021 Fall Report/out/Work_Term_Report_signed.pdf,c:/Users/awbmilne/Documents/School/Coop Reports/2021 Fall Report/out/Work_Term_Report.pdf
[14:38:42] Recipe step env: {}
[14:38:42] cwd: c:\Users\awbmilne\Documents\School\Coop Reports\2021 Fall Report
[14:38:42] LaTeX build process spawned. PID: 24396.

** At this point, nothing happens. Seems to hang (does not block LaTeX Workshops other functions **

Developer Tools Console

No dev tool console messages are produced during the running and once the progress seems to hang.

Desktop

• OS: Windows 10
• VS Code version: 1.63.2
• Extension version: v8.23.0
• TeX distribution version:
  • MiKTeX-TeX 4.3 (MiKTeX 21.3)
    using bzip2 version 1.0.8, 13-Jul-2019
    compiled with curl version 7.72.0; using libcurl/7.72.0 Schannel
    compiled with expat version 2.2.10; using expat_2.2.10
    compiled with liblzma version 50020052; using 50020052
    compiled with libressl version LibreSSL 3.1.4; using LibreSSL 3.1.4
    compiled with MiKTeX Application Framework version 4.1; using 4.1
    compiled with MiKTeX Core version 4.5; using 4.5
    compiled with MiKTeX Archive Extractor version 4.0; using 4.0
    compiled with MiKTeX Package Manager version 4.2.1; using 4.2.1
    compiled with uriparser version 0.9.4
    compiled with zlib version 1.2.11; using 1.2.11
  • Latexmk, John Collins, 16 May 2021. Version 4.74

Additional questions

Are you using VSCodium?

No

Are you using the Snap or Flatpack versions of VS Code?

No

Are you using LaTeX Workshop with VS Code Remote?

No

Additional context

I wonder if the issue is with the graphical pop-up from GPG for the Yubikey pin. Maybe however LaTeX Workshop is running the process is blocking the GUI and causing a stalemate.

Here is my full LaTeX workshop configuration:

    "latex-workshop.latex.autoBuild.run": "onSave",
    "latex-workshop.latex.clean.fileTypes": [ // sets the type of cleaning file
        "*.aux",
        "*.bbl",
        "*.blg",
        "*.idx",
        "*.ind",
        "*.lof",
        "*.lot",
        "*.out",
        "*.toc",
        "*.acn",
        "*.acr",
        "*.alg",
        "*.glg",
        "*.glo",
        "*.gls",
        "*.ist",
        "*.fls",
        "*.log",
        "*.fdb_latexmk",
        "*.nav",
        "*.snm",
        "*.synctex.gz"
    ],
    "latex-workshop.latex.outDir": "%DIR%/out",
    "latex-workshop.latex.recipe.default": "lastUsed",
    "latex-workshop.latex.recipes": [
        {
            "name": "latexmk",
            "tools": [
                "latexmk"
            ]
        },
        {
            "name": "latexmk + sign",
            "tools": [
                "latexmk",
                "signpdf"
            ]
        },
        {
            "name": "PDFlatex",
            "tools": [
                "pdflatex"
            ]
        },
        {
            "name": "pdflatex ->�� bibtex ->�� pdflatex2",
            "tools": [
                "pdflatex",
                "bibtex",
                "pdflatex",
                "pdflatex"
            ]
        },
        {
            "name": "xelatex",
            "tools": [
                "xelatex"
            ]
        },
        {
            "name": "xelatex -> bibtex -> xelatex",
            "tools": [
                "xelatex",
                "bibtex",
                "xelatex"
            ]
        }
    ],
    "latex-workshop.latex.tools": [
        {
            "args": [
                "-synctex=1",
                "-interaction=nonstopmode",
                "-file-line-error",
                "-pdf",
                "-outdir=%OUTDIR%",
                "%DOC%"
            ],
            "command": "latexmk",
            "env": {},
            "name": "latexmk"
        },
        {
            "args": [
                "-synctex=1",
                "-interaction=nonstopmode",
                "-file-line-error",
                "-outdir=%OUTDIR%",
                "%DOC%"
            ],
            "command": "pdflatex",
            "env": {},
            "name": "pdflatex"
        },
        {
            "args": [
                "-synctex=1",
                "-interaction=nonstopmode",
                "-file-line-error",
                "-output-directory=%OUTDIR%",
                "%DOC%"
            ],
            "command": "xelatex",
            "env": {},
            "name": "xelatex"
        },
        {
            "args": [
                "%DOCFILE%"
            ],
            "command": "bibtex",
            "env": {},
            "name": "bibtex"
        },
        {
            "args": [
                "--clearsign",
                "--not-dash-escaped",
                "--output=%OUTDIR%/%DOCFILE%_signed.pdf",
                "%OUTDIR%/%DOCFILE%.pdf"
            ],
            "command": "gpg",
            "env": {},
            "name": "signpdf"
        }
    ],
    "latex-workshop.view.pdf.viewer": "tab",

[James-Yu]

It looks like the window created by gpg does not work with the general framework of vscode extension. You may look for help in vscode's repo.