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.

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

Use readthedocs Docker image in CI #34

Closed
wtraylor opened this issue May 5, 2021 · 0 comments
Closed

Use readthedocs Docker image in CI #34

wtraylor opened this issue May 5, 2021 · 0 comments
Labels
refactoring Restructuring or rewriting of code

Comments

@wtraylor
Copy link
Owner

wtraylor commented May 5, 2021

The CI step "doxygen" in .gitlab-ci.yml currently runs with the ubuntu:latest Docker image. It needs various dependencies which take time and resources during CI.

It would make more sense to use the Docker image readthedocs/build:latest because that already has almost everything packaged (except cmake), and it is also the one used by Read the Docs to build the documentation (compare the docs). So the CI can catch potential issues before the release.

Unfortunately, the "latest" (7.0) does not contain the necessary Doxygen version (1.8.16), and the pipeline fails with it. ("testing", 8.0, seems to have a bug because conda is not available, which is required to install cmake.)

As soon as readthedocs/build:latest is updated to Ubuntu 20.04, we can use it in .gitlab-ci.yml like so:

doxygen:
  image: readthedocs/build:latest
  stage: build
  before_script:
    - conda install --yes cmake
  script:
    - mkdir --parents build
    - cd build
    - cmake
      -DSTOP_DOXYGEN_ON_WARNING=ON
      -DBUILD_TESTING=OFF
      -DBUILD_DEMO_SIMULATOR=OFF
      -DBUILD_DOC=ON ..
    - make --jobs=6 megafauna_docs
  artifacts:
    paths:
      - build/docs/html/
@wtraylor wtraylor added the refactoring Restructuring or rewriting of code label May 5, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
refactoring Restructuring or rewriting of code
Projects
None yet
Development

No branches or pull requests

1 participant