Skip to content
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

Jump to bottom

Fix broken build docs tests run with GitHub Actions #592

Merged
merged 2 commits into from
Jul 26, 2023
Merged

Fix broken build docs tests run with GitHub Actions #592

merged 2 commits into from
Jul 26, 2023

Commits on Jul 26, 2023

  1. Address git describe errors in GitHub Actions jobs 

    This commit contains changes to try to fix the tests TriBITS_build_docs and
TriBITS_build_sphinx_docs where the `git describe --match="<tag-base-name>*"`
command fails complaining there are not tags in the repo.

It seems that GitHub actions removed tag info with its git clone.  We have to
those tags back because they are used to generate the documentation which
includes the exact version.  A git fetch was done to bring back the tags.
However, that did not seem to work.

This commit also contains error handling for git describe command to produce a
dummy TribitsGitVersion.txt file in case the the git describe command fails.
This seems to have allowed the tests to pass.
    @bartlettroscoe
    bartlettroscoe committed Jul 26, 2023
    Configuration menu
    Copy the full SHA
    0b53bfc View commit details
    Browse the repository at this point in the history

  2. Add --always to git describe command 

    This will at least provide the SHA1 in case there is no tag info for some
reason.  This seems to be the case with GitHub Actions recently.
    @bartlettroscoe
    bartlettroscoe committed Jul 26, 2023
    Configuration menu
    Copy the full SHA
    928e562 View commit details
    Browse the repository at this point in the history