Skip to content

Workflow fails

Jump to bottom
Agah edited this page Nov 11, 2020 · 3 revisions

What to do when an action run fails?

Check which job has failed by visiting the Actions tab of your repository and clicking the latest workflow run.

There are 3 jobs running for the Report workflow:

  • updateInfo

    • This is the simplest task. It is only responsible for changing a few lines in your report.bib each time you push a commit.
    • If this task is failing, it is most likely due to a problem with the personal access token (PAT) you added to your repository. Please make sure that the secret has the name PAT_BHP and has the scope of repo.
    • Please open an issue if the problem persists.

  • buildPDF

The best practice is to click on the build log and scroll down until you see the error message. It usually tells you at which line of which file the compilation run into a problem. Some common problems are:

    • Missing/mismatched bibliography entry. Happens when report.bib is inquired for a non-existing citation label. For example, \cite{author:2009} command in the report.bib if a citation with the author:2009 label is missing in the report.bib.

    • Missing/mismatched figure. Figures are expected in the figures folder. This way, you can add them in your report without defining paths (e.g., \includegraphics[width=.47\textwidth]{brainhack.png}). But if brainhack.png does not exist in the figures folder, then the PDF build will fail. We highly encourage you to add your figures to your repository instead of linking them externally for the longevity purposes.

    • Issues with the LaTeX format. The report.md is a LaTeX flavoured markdown. If you opened a { but forgot closing it, or used one of the special latex characters &, %, $, #, _, { } \ without escape notations, the PDF build may fail. You can visit this link to see how to use special characters when you need them. I am sure \ will throw an exception, but looks like using & was OK. Anyway, just make a mental note about it :)

  • buildHugo

At this stage, the actions will checkout your repository and the brainhack-proceedings/template-web repo to blend your content into the HUGO (static web-page builder) resources. A successful run would push web-page content to the gh-pages branch of your repository.

    • An error is much less likely to happen if the first two jobs completed successfully.
    • Feel free to open an issue.

Clone this wiki locally