diff --git a/.github/workflows/documentation-build.yml b/.github/workflows/documentation-build.yml index 933f43d28..178aa4245 100644 --- a/.github/workflows/documentation-build.yml +++ b/.github/workflows/documentation-build.yml @@ -11,12 +11,18 @@ on: - 'doxygen_style.css' workflow_dispatch: +env: + COCKATRICE_REF: ${{ github.ref_name }} # Gives tag name if the commit is tagged, otherwise branch name + jobs: docs: name: Doxygen runs-on: ubuntu-latest steps: + - name: Print environment variable + run: echo $COCKATRICE_REF + - name: Checkout code uses: actions/checkout@v5 diff --git a/Doxyfile b/Doxyfile index 298edc7f7..c01a60eba 100644 --- a/Doxyfile +++ b/Doxyfile @@ -1,4 +1,5 @@ # Doxyfile 1.14.0 +# Docs: https://www.doxygen.nl/manual # This file describes the settings to be used by the documentation system # Doxygen (www.doxygen.org) for a project. @@ -48,13 +49,13 @@ PROJECT_NAME = "Cockatrice" # could be handy for archiving the generated documentation or if some version # control system is used. -PROJECT_NUMBER = 2.11 +PROJECT_NUMBER = $(COCKATRICE_REF) # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewers a # quick idea about the purpose of the project. Keep the description short. -PROJECT_BRIEF = +PROJECT_BRIEF = A cross-platform virtual tabletop for multiplayer card games # With the PROJECT_LOGO tag one can specify a logo or an icon that is included # in the documentation. The maximum height of the logo should not exceed 55