Skip to content

Conversation

ludovicsteinbach
Copy link
Contributor

@ludovicsteinbach ludovicsteinbach commented Apr 19, 2024

Closes #549
Start #494

Use Ansys actions for doc build and deployment.
This will temporarily deploy to a new gh-page site, as this is still using a second repo for the docs. This actually gives us an opportunity to confirm all works well before switching out the CNAME.

Required follow-up tasks:

  • Update CNAME to openapi.docs.ansys.com and retire ansys/openapi-common-docs
  • Address references errors and build docs in nitpicky mode

@github-actions github-actions bot added maintenance Package and maintenance related dependencies Related with project dependencies labels Apr 19, 2024
@codecov-commenter
Copy link

codecov-commenter commented Apr 19, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.25%. Comparing base (a3602e0) to head (b821e63).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #555   +/-   ##
=======================================
  Coverage   94.25%   94.25%           
=======================================
  Files           7        7           
  Lines         783      783           
=======================================
  Hits          738      738           
  Misses         45       45           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Apr 19, 2024
@da1910 da1910 force-pushed the ci/use-ansys-actions branch from f4b6d46 to 9e3e7fa Compare May 2, 2024 10:39
@ludovicsteinbach ludovicsteinbach requested a review from da1910 May 2, 2024 12:17
@ludovicsteinbach ludovicsteinbach marked this pull request as ready for review May 2, 2024 12:18
Copy link
Collaborator

@da1910 da1910 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Possibly a change in the cname file, at least a question

pyproject.toml Outdated
sphinx-notfound-page = { version = "1.0.0" }
sphinx-copybutton = { version = "0.5.2" }
# Duplicate extra - required to use ansys/actions/doc-build
requests-kerberos = {version = "^0.13", markers = "sys_platform == 'linux'" }
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We ought to submit a ticket to get extras supported by actions

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I ended up extracting a dependency to a new group.

Dev dependencies are not optional, so they get installed by poetry install, which is what actions typically use. Because asgi_gssapi requires gssapi, most jobs required installing kerberos headers.
It's now installed via the tox env config, and thus is only required for tests.

This reverts commit 4b98031.

Revert "Make dev deps optional"

This reverts commit aedda61.

Revert "Add mypy dependency in pre-commit config"

This reverts commit 73f9c00.

Revert "Fix mypy config"

This reverts commit 35db4af.
Copy link
Collaborator

@da1910 da1910 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't remember if we have any instructions for developers, but we should think about whether can can add a note to make sure it's clear we do need to add this to develop on the linux tests

@ludovicsteinbach ludovicsteinbach merged commit 94789ef into main May 3, 2024
@ludovicsteinbach ludovicsteinbach deleted the ci/use-ansys-actions branch May 3, 2024 08:16
ludovicsteinbach added a commit that referenced this pull request May 3, 2024
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Doug Addy <doug.addy@ansys.com>
Co-authored-by: pyansys-ci-bot <pyansys.github.bot@ansys.com>
@ludovicsteinbach ludovicsteinbach removed the dependencies Related with project dependencies label May 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation maintenance Package and maintenance related

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Use Ansys actions

4 participants