search

ansys / actions

A collection of reusable workflows
https://actions.docs.ansys.com/
MIT License
10 stars 5 forks source link

Problem in determining the build backend in doc-build actions when no pyproject.toml file exist #544

Closed SMoraisAnsys closed 1 week ago

SMoraisAnsys commented 3 weeks ago

At the moment there is no check on the existence of the pyproject.toml file in our doc build actions. However, this file is leveraged to decide which backend should be used in our CICD, see https://github.com/ansys/actions/blob/8643c5a882d18be06255fa8cc6e32bd9cc7e8cf1/_doc-build-linux/action.yml#L188 and https://github.com/ansys/actions/blob/8643c5a882d18be06255fa8cc6e32bd9cc7e8cf1/_doc-build-linux/action.yml#L198.

If this is a requirement then we should put it somewhere in the documentation. If that's not the case then we should fix the current action to add this check. Note that this would help projects which have no pyproject.toml file, e.g. projects mainly composed of examples. Currently, I'm not sure that they are able to use the doc-build action.

Note: speaking of projects without pyproject.toml file, we could use pip as default backend in those cases. What do you think ?

RobPasMue commented 3 weeks ago

Which project is still not using pyproject.toml?

SMoraisAnsys commented 3 weeks ago

Which project is still not using pyproject.toml?

I was mainly thinking about example repos, e.g. pymapdl-examples or pymechanical-examples.

I don't think we have other public repos without pyproject.toml

RobPasMue commented 3 weeks ago

Fine in that case =)

MaxJPRey commented 3 weeks ago

Agreed to use pip by default.