From a1d038de3161292fcc87938670f084ea84b38c1d Mon Sep 17 00:00:00 2001 From: Stefan Fabian Date: Fri, 9 Aug 2024 15:28:15 +0200 Subject: [PATCH 01/17] Initial ros2 pipeline. --- .github/workflows/{ci.yml => ci-ros1.yml} | 6 ++-- .github/workflows/ci-ros2.yml | 44 +++++++++++++++++++++++ .github/workflows/documentation.yml | 7 ++-- 3 files changed, 50 insertions(+), 7 deletions(-) rename .github/workflows/{ci.yml => ci-ros1.yml} (93%) create mode 100644 .github/workflows/ci-ros2.yml diff --git a/.github/workflows/ci.yml b/.github/workflows/ci-ros1.yml similarity index 93% rename from .github/workflows/ci.yml rename to .github/workflows/ci-ros1.yml index 2a9d7b5..2031b0d 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci-ros1.yml @@ -1,9 +1,9 @@ name: Build & Test on: push: - branches: [ master ] + branches: [ noetic, jazzy ] pull_request: - branches: [ master ] + branches: [ noetic, jazzy ] jobs: Linting: @@ -34,7 +34,7 @@ jobs: run: | sudo apt-get update sudo apt-get install -y python3-catkin-tools python3-empy - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 with: path: hector/src - name: rosdep diff --git a/.github/workflows/ci-ros2.yml b/.github/workflows/ci-ros2.yml new file mode 100644 index 0000000..6f6fb70 --- /dev/null +++ b/.github/workflows/ci-ros2.yml @@ -0,0 +1,44 @@ +name: Build & Test +on: + push: + branches: [ jazzy ] + pull_request: + branches: [ jazzy ] + +jobs: + Linting: + name: Lint Code Base + runs-on: ubuntu-latest + steps: + - name: Checkout Code + uses: actions/checkout@v4 + with: + fetch-depth: 0 + - name: Setup + run: | + sudo apt-get update && sudo apt-get install -y clang-format cppcheck libxml2-utils + - name: Lint C++ + run: | + clang-format -Werror -n -style=file $(find . -name '*.cpp' -o -name '*.hpp' -o -name '*.h' -o -name '*.c' -o -name '*.cc') + - name: Check C++ + run: | + cppcheck --force --quiet --error-exitcode=1 . + - name: Lint package.xml + run: | + xmllint --noout --schema http://download.ros.org/schema/package_format3.xsd $(find . -name 'package.xml') + + build-and-test: + needs: Linting + runs-on: ubuntu-latest + strategy: + matrix: + ros_distro: [humble, jazzy] + container: + image: ros:${{matrix.ros_distro}}-ros-base + steps: + - uses: ros-tooling/setup-ros@v0.7 + with: + required-ros-distributions: ${{ matrix.ros_distro }} + - uses: ros-tooling/action-ros-ci@v0.3 + with: + target-ros2-distro: ${{ matrix.ros_distro }} diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 91dde2d..ab9fa05 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -1,11 +1,11 @@ name: Documentation Build on: push: - branches: [ master ] + branches: [ noetic, jazzy ] jobs: documentation: - runs-on: ubuntu-latest + runs-on: debian-latest container: debian:buster-slim steps: - name: Prerequisites @@ -15,10 +15,9 @@ jobs: shell: bash - name: Checkout Code - uses: actions/checkout@v3 + uses: actions/checkout@v4 with: fetch-depth: 0 - # ref: master # make sure to use documentation script from master branch - name: Execute script to build our documentation and update pages env: From 062e1cbdcf6e9bfb1f944fe691add8cb29fc28e3 Mon Sep 17 00:00:00 2001 From: Stefan Fabian Date: Fri, 9 Aug 2024 15:35:36 +0200 Subject: [PATCH 02/17] Don't run noetic CI on jazzy. --- .github/workflows/ci-ros1.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/ci-ros1.yml b/.github/workflows/ci-ros1.yml index 2031b0d..96f9dca 100644 --- a/.github/workflows/ci-ros1.yml +++ b/.github/workflows/ci-ros1.yml @@ -1,9 +1,9 @@ name: Build & Test on: push: - branches: [ noetic, jazzy ] + branches: [ noetic ] pull_request: - branches: [ noetic, jazzy ] + branches: [ noetic ] jobs: Linting: From 634fbadd6a96e54ffab12dada310be40b25014af Mon Sep 17 00:00:00 2001 From: Stefan Fabian Date: Fri, 9 Aug 2024 15:46:21 +0200 Subject: [PATCH 03/17] Updated documentation build. --- .github/build_docs_on_github.sh | 154 ---------------------------- .github/workflows/documentation.yml | 24 ++++- 2 files changed, 20 insertions(+), 158 deletions(-) delete mode 100755 .github/build_docs_on_github.sh diff --git a/.github/build_docs_on_github.sh b/.github/build_docs_on_github.sh deleted file mode 100755 index 3786cbe..0000000 --- a/.github/build_docs_on_github.sh +++ /dev/null @@ -1,154 +0,0 @@ -#!/bin/bash -set -x - -# file adapted from https://tech.michaelaltfield.net/2020/07/18/sphinx-rtd-github-pages-1 by Michael Altfield -# added doxygen code documentation and downgraded docutils (otherwise bullet points are not shown correctly) - -##################### -# GO TO DOCS FOLDER # -##################### - -cd ../hector_math || { echo "Error: Failed to change directory"; exit 1; } - -################### -# INSTALL DEPENDS # -################### - -apt-get update -apt-get -y install git rsync python3-sphinx python3-sphinx-rtd-theme python3-stemmer python3-git python3-pip python3-virtualenv python3-setuptools - -python3 -m pip install --upgrade rinohtype pygments breathe sphinxcontrib-video -python3 -m pip install -I docutils==0.16 - -##################### -# DECLARE VARIABLES # -##################### -export REPO_NAME="${GITHUB_REPOSITORY##*/}" -git config --global --add safe.directory /__w/${REPO_NAME}/${REPO_NAME} -pwd -ls -lah -export SOURCE_DATE_EPOCH=$(git log -1 --pretty=%ct) - -# make a new temp dir which will be our GitHub Pages docroot -docroot=$(mktemp -d) - -############## -# BUILD DOCS # -############## - -# first, cleanup any old builds' static assets -make -C docs clean -if [ $? -ne 0 ]; then - echo "Failed to clean docs" - exit 1 -fi - - - -# only build documentation for master branch - -current_version="master" - -git checkout "${current_version}" -# make the current language available to conf.py -export current_version - -echo "INFO: Building sites for ${current_version}" - -# skip this branch if it doesn't have our docs dir & sphinx config -if [ ! -e 'docs/conf.py' ]; then - echo -e "\tINFO: Couldn't find 'docs/conf.py' (skipped)" - exit 2 -fi - -#languages="en `find docs/locales/ -mindepth 1 -maxdepth 1 -type d -exec basename '{}' \;`" -current_language='en' - -# make the current language available to conf.py -export current_language - -########## -# BUILDS # -########## -echo "INFO: Building for ${current_language}" -# HTML # -sphinx-build -b html docs/ docs/_build/html/${current_language}/"${current_version}" -D language="${current_language}" - -# PDF # Not working somehow rinoh fails due to @endverbatim and @see tags -#echo "Start pdf build" -#sphinx-build -b rinoh docs/ docs/_build/rinoh -D language="${current_language}" -#mkdir -p "${docroot}/${current_language}/${current_version}" -#cp "docs/_build/rinoh/target.pdf" "${docroot}/${current_language}/${current_version}/hector_math-docs_${current_language}_${current_version}.pdf" -#echo "End pdf build" - -# EPUB # -sphinx-build -b epub docs/ docs/_build/epub -D language="${current_language}" -mkdir -p "${docroot}/${current_language}/${current_version}" -cp "docs/_build/epub/target.epub" "${docroot}/${current_language}/${current_version}/hector_math-docs_${current_language}_${current_version}.epub" - -# copy the static assets produced by the above build into our docroot -rsync -av "docs/_build/html/" "${docroot}/" - -# return to master branch -git checkout master - -####################### -# Update GitHub Pages # -####################### - -git config --global user.name "${GITHUB_ACTOR}" -git config --global user.email "${GITHUB_ACTOR}@users.noreply.github.com" - -pushd "${docroot}" || exit 1 - -# don't bother maintaining history; just generate fresh -git init -git remote add deploy "https://token:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git" -git checkout -b gh-pages - -# add .nojekyll to the root so that github won't 404 on content added to dirs -# that start with an underscore (_), such as our "_content" dir.. -touch .nojekyll - -# add redirect from the docroot to our default docs language/version -cat >index.html < - - - hector_math Docs - - - -

Please wait while you're redirected to our master.

- - -EOF - -# Add README -cat >README.md < Date: Fri, 9 Aug 2024 15:54:25 +0200 Subject: [PATCH 04/17] Github only supports one pages deployment, so we only deploy on latest branch. --- .github/workflows/documentation.yml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 168c852..5480a69 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -1,7 +1,9 @@ name: Documentation on: push: - branches: [ noetic, jazzy ] + branches: [ jazzy ] + pull_request: + branches: [ jazzy ] jobs: build: From 740c1a8536700557b102205f1588a9728cb0b763 Mon Sep 17 00:00:00 2001 From: Stefan Fabian Date: Fri, 9 Aug 2024 18:20:08 +0200 Subject: [PATCH 05/17] Updated documentation build. --- .github/workflows/documentation.yml | 11 ++--------- 1 file changed, 2 insertions(+), 9 deletions(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 5480a69..acb2b53 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -7,26 +7,19 @@ on: jobs: build: - runs-on: debian-latest - container: debian:buster-slim + runs-on: ubuntu-latest steps: - name: Prerequisites run: | apt-get update apt-get install -y git doxygen graphviz - shell: bash - - name: Checkout Code uses: actions/checkout@v4 with: fetch-depth: 0 - - - name: Execute script to build our documentation and update pages - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + - name: Build documentation run: | cd docs && make html - shell: bash - uses: actions/upload-pages-artifact@v1 with: name: github-pages From a4539d8eeaac13d89923c29da601726a3caf339b Mon Sep 17 00:00:00 2001 From: Stefan Fabian Date: Fri, 9 Aug 2024 18:24:39 +0200 Subject: [PATCH 06/17] Updated documentation setup step. --- .github/workflows/documentation.yml | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index acb2b53..ca5712c 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -9,10 +9,9 @@ jobs: build: runs-on: ubuntu-latest steps: - - name: Prerequisites + - name: Setup run: | - apt-get update - apt-get install -y git doxygen graphviz + apt-get update && apt-get install -y git doxygen graphviz python3-sphinx python3-breathe python3-sphinx-rtd-theme - name: Checkout Code uses: actions/checkout@v4 with: From 3ec8e9cfc206b6836f470fe23cd74c4682e07441 Mon Sep 17 00:00:00 2001 From: Stefan Fabian Date: Fri, 9 Aug 2024 18:26:09 +0200 Subject: [PATCH 07/17] Added missing sudo. --- .github/workflows/documentation.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index ca5712c..cd177f1 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -9,13 +9,13 @@ jobs: build: runs-on: ubuntu-latest steps: - - name: Setup - run: | - apt-get update && apt-get install -y git doxygen graphviz python3-sphinx python3-breathe python3-sphinx-rtd-theme - name: Checkout Code uses: actions/checkout@v4 with: fetch-depth: 0 + - name: Setup + run: | + sudo apt-get update && sudo apt-get install -y git doxygen graphviz python3-sphinx python3-breathe python3-sphinx-rtd-theme - name: Build documentation run: | cd docs && make html From 63e4580f0a48d8b6bb72e38678d9576cddfb7e0d Mon Sep 17 00:00:00 2001 From: Stefan Fabian Date: Fri, 9 Aug 2024 18:37:10 +0200 Subject: [PATCH 08/17] Updated docs conf. --- docs/conf.py | 105 +++++++-------------------------------------------- 1 file changed, 13 insertions(+), 92 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index a495a58..399c213 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -29,7 +29,7 @@ author = "Stefan Fabian" # The short X.Y version -version = "" +version = "1.0" # The full version, including alpha/beta/rc tags release = "1.0.0" @@ -97,88 +97,6 @@ # html_sidebars = {} -# -- Options for HTMLHelp output --------------------------------------------- - -# Output file base name for HTML help builder. -htmlhelp_basename = "hector_mathdoc" - -# -- Options for LaTeX output ------------------------------------------------ - -latex_elements = { - # The paper size ('letterpaper' or 'a4paper'). - # - # 'papersize': 'letterpaper', - # The font size ('10pt', '11pt' or '12pt'). - # - # 'pointsize': '10pt', - # Additional stuff for the LaTeX preamble. - # - # 'preamble': '', - # Latex figure (float) alignment - # - # 'figure_align': 'htbp', -} - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, -# author, documentclass [howto, manual, or own class]). -latex_documents = [ - ( - master_doc, - "hector_math.tex", - "hector_math Documentation", - "Stefan Fabian", - "manual", - ), -] - -# -- Options for manual page output ------------------------------------------ - -# One entry per manual page. List of tuples -# (source start file, name, description, authors, manual section). -man_pages = [(master_doc, "helloworld", "hector_math Documentation", [author], 1)] - -# -- Options for Texinfo output ---------------------------------------------- - -# Grouping the document tree into Texinfo files. List of tuples -# (source start file, target name, title, author, -# dir menu entry, description, category) -texinfo_documents = [ - ( - master_doc, - "hector_math", - "hector_math Documentation", - author, - "hector_math", - "One line description of project.", - "Miscellaneous", - ), -] - -# -- Options for Epub output ------------------------------------------------- - -# Bibliographic Dublin Core info. -epub_title = project - -# The unique identifier of the text. This can be a ISBN number -# or the project homepage. -# -# epub_identifier = '' - -# A unique identification for the text. -# -# epub_uid = '' - -# A list of files that should not be packed into the epub file. -epub_exclude_files = ["search.html"] - -# -- Extension configuration ------------------------------------------------- - -# add sourcecode to path -import sys, os - -sys.path.insert(0, os.path.abspath("../src")) - ############################ # SETUP THE RTD LOWER-LEFT # ############################ @@ -206,17 +124,20 @@ html_context["current_language"] = current_language # SET CURRENT_VERSION -from git import Repo - -repo = Repo(search_parent_directories=True) - if "current_version" in os.environ: # get the current_version env var set by buildDocs.sh - current_version = os.environ["current_version"] + current_version = os.environ["GITHUB_REF_NAME"] else: - # the user is probably doing `make html` - # set this build's current version by looking at the branch - current_version = repo.active_branch.name + try: + from git import Repo + + repo = Repo(search_parent_directories=True) + + # the user is probably doing `make html` + # set this build's current version by looking at the branch + current_version = repo.active_branch.name + except ImportError: + current_version = "unknown" # tell the theme which version we're currently on ('current_version' affects # the lower-left rtd menu and 'version' affects the logo-area version) @@ -301,4 +222,4 @@ html_context["display_github"] = True html_context["github_user"] = "tu-darmstadt-ros-pkg" html_context["github_repo"] = "hector_math" -html_context["github_version"] = "master/docs/" +html_context["github_version"] = f"{current_version}/docs/" From 77070ea7a36b48c522fac5bf573e18b32680f1b5 Mon Sep 17 00:00:00 2001 From: Stefan Fabian Date: Mon, 12 Aug 2024 10:16:43 +0200 Subject: [PATCH 09/17] Add asan to CI tests to find memory issues. --- .github/workflows/ci-ros2.yml | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/.github/workflows/ci-ros2.yml b/.github/workflows/ci-ros2.yml index 6f6fb70..a8b46c5 100644 --- a/.github/workflows/ci-ros2.yml +++ b/.github/workflows/ci-ros2.yml @@ -42,3 +42,9 @@ jobs: - uses: ros-tooling/action-ros-ci@v0.3 with: target-ros2-distro: ${{ matrix.ros_distro }} + colcon-defaults: | # Use asan to find memory issues + { + "build": { + "mixin": ["asan-gcc"] + } + } From 460f9ea3585f8c637c1f46942af7ae8f83497aa7 Mon Sep 17 00:00:00 2001 From: Stefan Fabian Date: Mon, 12 Aug 2024 10:18:43 +0200 Subject: [PATCH 10/17] Build hector_math_py before building documentation to enable automatic generation of graphics. --- .github/workflows/documentation.yml | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index cd177f1..54b8c32 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -1,13 +1,15 @@ name: Documentation on: push: - branches: [ jazzy ] + branches: [ $default-branch ] pull_request: - branches: [ jazzy ] + branches: [ $default-branch ] jobs: build: runs-on: ubuntu-latest + container: + image: ros:jazzy-ros-base steps: - name: Checkout Code uses: actions/checkout@v4 @@ -16,10 +18,18 @@ jobs: - name: Setup run: | sudo apt-get update && sudo apt-get install -y git doxygen graphviz python3-sphinx python3-breathe python3-sphinx-rtd-theme + - uses: ros-tooling/setup-ros@v0.7 + with: + required-ros-distributions: jazzy + - uses: ros-tooling/action-ros-ci@v0.3 + with: + package-name: hector_math hector_math_py + target-ros2-distro: jazzy + skip-tests: true - name: Build documentation run: | - cd docs && make html - - uses: actions/upload-pages-artifact@v1 + . ../../install/setup.sh && cd docs && make html + - uses: actions/upload-pages-artifact@v4 with: name: github-pages path: docs/_build/html From e6ae06b9d4cad4ea369b558a1219bd5686d00331 Mon Sep 17 00:00:00 2001 From: Stefan Fabian Date: Mon, 12 Aug 2024 11:24:26 +0200 Subject: [PATCH 11/17] Disable asan new-delete-type-mismatch since rcutils triggers it. --- .github/workflows/ci-ros2.yml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.github/workflows/ci-ros2.yml b/.github/workflows/ci-ros2.yml index a8b46c5..71e5f7c 100644 --- a/.github/workflows/ci-ros2.yml +++ b/.github/workflows/ci-ros2.yml @@ -30,6 +30,10 @@ jobs: build-and-test: needs: Linting runs-on: ubuntu-latest + # Disable asan new-delete-type-mismatch to workaround rcutils issue + # https://github.com/ros2/rclcpp/issues/2220 + env: + ASAN_OPTIONS: new_delete_type_mismatch=0 strategy: matrix: ros_distro: [humble, jazzy] From d5457f956cc4fab905e747a2d79758bd6c18c006 Mon Sep 17 00:00:00 2001 From: Stefan Fabian Date: Mon, 12 Aug 2024 11:28:35 +0200 Subject: [PATCH 12/17] $default-branch is only available in templates not in actual workflow instances. Only deploy if not a PR. --- .github/workflows/documentation.yml | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 54b8c32..e56b73b 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -1,9 +1,9 @@ name: Documentation on: push: - branches: [ $default-branch ] + branches: [ jazzy ] pull_request: - branches: [ $default-branch ] + branches: [ jazzy ] jobs: build: @@ -44,5 +44,6 @@ jobs: runs-on: ubuntu-latest steps: - name: Deploy to GitHub Pages + if: github.event_name != 'pull_request' id: deployment uses: actions/deploy-pages@v4 From a93cf1187da092419dca0eedba35fd074a0a78ab Mon Sep 17 00:00:00 2001 From: Stefan Fabian Date: Mon, 12 Aug 2024 11:29:51 +0200 Subject: [PATCH 13/17] Changed upload pages artifact version to v3. --- .github/workflows/documentation.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index e56b73b..3ac036e 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -29,7 +29,7 @@ jobs: - name: Build documentation run: | . ../../install/setup.sh && cd docs && make html - - uses: actions/upload-pages-artifact@v4 + - uses: actions/upload-pages-artifact@v3 with: name: github-pages path: docs/_build/html From 0e622374765f422200f902890d33f8ffb1e4ffdd Mon Sep 17 00:00:00 2001 From: Stefan Fabian Date: Mon, 12 Aug 2024 11:39:31 +0200 Subject: [PATCH 14/17] Update sourcing of built packages. --- .github/workflows/documentation.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 3ac036e..3a62fa2 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -22,13 +22,14 @@ jobs: with: required-ros-distributions: jazzy - uses: ros-tooling/action-ros-ci@v0.3 + id: action_ros_ci_step with: package-name: hector_math hector_math_py target-ros2-distro: jazzy skip-tests: true - name: Build documentation run: | - . ../../install/setup.sh && cd docs && make html + . ${{ steps.action_ros_ci_step.outputs.ros-workspace-directory-name }}/install/setup.sh && cd docs && make html - uses: actions/upload-pages-artifact@v3 with: name: github-pages From bd2012ee128657a81f9a96d3e53cb3052e715e1d Mon Sep 17 00:00:00 2001 From: Stefan Fabian Date: Mon, 12 Aug 2024 11:45:35 +0200 Subject: [PATCH 15/17] Make entire documentation deploy job conditional on "is not a pull request" not just the deploy step. --- .github/workflows/documentation.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 3a62fa2..72a6558 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -35,6 +35,7 @@ jobs: name: github-pages path: docs/_build/html deploy: + if: github.event_name != 'pull_request' needs: build permissions: pages: write @@ -45,6 +46,5 @@ jobs: runs-on: ubuntu-latest steps: - name: Deploy to GitHub Pages - if: github.event_name != 'pull_request' id: deployment uses: actions/deploy-pages@v4 From e98872601e0f30e170b4b966eb748ab0f9937008 Mon Sep 17 00:00:00 2001 From: Stefan Fabian Date: Tue, 3 Sep 2024 09:58:06 +0200 Subject: [PATCH 16/17] Fixed check for GITHUB_REF_NAME in docs build. --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 399c213..945e7eb 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -124,7 +124,7 @@ html_context["current_language"] = current_language # SET CURRENT_VERSION -if "current_version" in os.environ: +if "GITHUB_REF_NAME" in os.environ: # get the current_version env var set by buildDocs.sh current_version = os.environ["GITHUB_REF_NAME"] else: From 4731af7f9003633ccd002457f5b041adf6110111 Mon Sep 17 00:00:00 2001 From: Stefan Fabian Date: Tue, 3 Sep 2024 10:03:23 +0200 Subject: [PATCH 17/17] Install python3-git in docs workflow. --- .github/workflows/documentation.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 72a6558..4e72e18 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -17,7 +17,7 @@ jobs: fetch-depth: 0 - name: Setup run: | - sudo apt-get update && sudo apt-get install -y git doxygen graphviz python3-sphinx python3-breathe python3-sphinx-rtd-theme + sudo apt-get update && sudo apt-get install -y git doxygen graphviz python3-sphinx python3-breathe python3-sphinx-rtd-theme python3-git - uses: ros-tooling/setup-ros@v0.7 with: required-ros-distributions: jazzy