fix build error and add enhancements

[dariusptrs]

• fix build error: Running git config --global --add safe.directory $GITHUB_WORKSPACE before the build allows cmake to write into 'git.id' and fixes the following build error:

./CheatsheetTemplate.tex:62: Undefined control sequence.
\themydate ->\GitNiceDate 
                          \ (git \GitRevision )
l.62 \end{document}

• Suggestion: add a "Update README and LaTeX Build File" workflow to make using the template easier

• Suggestion: add a hyperlink into every document that directly forwards the user to the repo's issues page. (For that also see my PR in latex4ei-packages here: Add issues hyperlink and fix CI latex4ei-packages#6)

[hofbi]

Thanks for your contributions! Just a few comments to be discussed

[hofbi]

Thanks for your efforts so far. Just a few more comments for the python code

[dariusptrs]

I just did some tests with the new workflow. Everything seems to work.

[hofbi]

Almost good.

Another cool thing we could do is to create some unit tests for our Python script (can be a follow up PR, if you want). For this, I would recommend pytest and its fakefilesystem plugin. This makes it super easy to unit test file io operations without writing to the disk.

[dariusptrs]

I tried to add the unit tests. The test now only fails for the CMakeLists.txt. I can look into that later, or maybe you also find the mistake until then.

[dariusptrs]

I tried to add the unit tests. The test now only fails for the CMakeLists.txt. I can look into that later, or maybe you also find the mistake until then.

E       AssertionError: CMakeLists.txt content was not updated correctly.
E       assert 'cmake_minimum_required(VERSION 3.12)\nproject(correct_title Add the main LaTeX correct_title.tex\nFORCE_PDF\nIMAGE_DIRS img\nDEPENDS writegitid\n)\n' == 'cmake_minimum_required(VERSION 3.12)\nproject(correct_title)\n# Add the main LaTeX document\nadd_latex_document(\ncorrect_title.tex\nAnotherDoc.tex\nFORCE_PDF\nIMAGE_DIRS img\nDEPENDS writegitid\n)\n'
E         
E           cmake_minimum_required(VERSION 3.12)
E         + project(correct_title Add the main LaTeX correct_title.tex
E         - project(correct_title)
E         - # Add the main LaTeX document
E         - add_latex_document(
E         - correct_title.tex
E         - AnotherDoc.tex
E           FORCE_PDF
E           IMAGE_DIRS img
E           DEPENDS writegitid
E           )

/Users/darius/Documents/GitHub/CheatsheetTemplate/scripts/tests/test_update_files.py:77: AssertionError
=========================== short test summary info ============================
FAILED scripts/tests/test_update_files.py::test_update_cmake_content - AssertionError: CMakeLists.txt content was not updated correctly.

[dariusptrs]

I tried to add the unit tests. The test now only fails for the CMakeLists.txt. I can look into that later, or maybe you also find the mistake until then.

E       AssertionError: CMakeLists.txt content was not updated correctly.
E       assert 'cmake_minimum_required(VERSION 3.12)\nproject(correct_title Add the main LaTeX correct_title.tex\nFORCE_PDF\nIMAGE_DIRS img\nDEPENDS writegitid\n)\n' == 'cmake_minimum_required(VERSION 3.12)\nproject(correct_title)\n# Add the main LaTeX document\nadd_latex_document(\ncorrect_title.tex\nAnotherDoc.tex\nFORCE_PDF\nIMAGE_DIRS img\nDEPENDS writegitid\n)\n'
E         
E           cmake_minimum_required(VERSION 3.12)
E         + project(correct_title Add the main LaTeX correct_title.tex
E         - project(correct_title)
E         - # Add the main LaTeX document
E         - add_latex_document(
E         - correct_title.tex
E         - AnotherDoc.tex
E           FORCE_PDF
E           IMAGE_DIRS img
E           DEPENDS writegitid
E           )

/Users/darius/Documents/GitHub/CheatsheetTemplate/scripts/tests/test_update_files.py:77: AssertionError
=========================== short test summary info ============================
FAILED scripts/tests/test_update_files.py::test_update_cmake_content - AssertionError: CMakeLists.txt content was not updated correctly.

Still found some time. I think it's fixed now.

[hofbi]

I think we can merge this into the ci.yml. Let's put it between the checkout and the git add safe dir step.

Since it is super fast and we don't have that many changes, we don't need the extra path/changes logic.

[dariusptrs]

I removed the hours and minutes from the Last revised because I think it is unnecessary and we have \GitRevision to track the exact commit.