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

fix: command context when no pyproject.toml #557

Merged
merged 1 commit into from
Sep 5, 2024

Conversation

SMoraisAnsys
Copy link
Contributor

@SMoraisAnsys SMoraisAnsys commented Sep 5, 2024

This PR make the doc-build action compatible with repos without pyproject.toml file. This is typically the case for repositories dedicated to example, e.g. pymapdl-examples or pymechanical-examples.

Note: the default behavior in such case is to not use ``poetry` command.

Close #544

@SMoraisAnsys SMoraisAnsys requested a review from a team as a code owner September 5, 2024 09:24
@ansys-reviewer-bot
Copy link
Contributor

Thanks for opening a Pull Request. If you want to perform a review write a comment saying:

@ansys-reviewer-bot review

@github-actions github-actions bot added the bug Defects or glitches reported by users or developers label Sep 5, 2024
@Revathyvenugopal162
Copy link
Contributor

Revathyvenugopal162 commented Sep 5, 2024

We have skip-install for the libraries that don't have pyproject.toml. Example our dev guide https://github.com/ansys/pyansys-dev-guide/blob/ae61cd29db323dbfa6b62dd5dd36af18082d502a/.github/workflows/ci_cd.yml#L54. Isn't it enough for the repos without pyproject.toml file? or perhaps we could combine both if they serve the same purpose?

Copy link
Member

@RobPasMue RobPasMue left a comment

Choose a reason for hiding this comment

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

Sounds good to me!

@SMoraisAnsys
Copy link
Contributor Author

We have skip-install for the libraries that don't have pyproject.toml. Example our dev guide https://github.com/ansys/pyansys-dev-guide/blob/ae61cd29db323dbfa6b62dd5dd36af18082d502a/.github/workflows/ci_cd.yml#L54. Isn't it enough for the repos without pyproject.toml file? or perhaps we could combine both if they serve the same purpose?

It is not a problem when you install the doc dependencies. It is a problem that arises when the action tries to determine which command should be used to launch the documentation build (using poetry or not). I checked the repo `pyansys-dev-guide``and it seems that you have an error but it is not failing the workflow as you are running in Linux, see below

image

However, when I try to use it in a Windows environment here is what I get

image

@Revathyvenugopal162
Copy link
Contributor

We have skip-install for the libraries that don't have pyproject.toml. Example our dev guide https://github.com/ansys/pyansys-dev-guide/blob/ae61cd29db323dbfa6b62dd5dd36af18082d502a/.github/workflows/ci_cd.yml#L54. Isn't it enough for the repos without pyproject.toml file? or perhaps we could combine both if they serve the same purpose?

It is not a problem when you install the doc dependencies. It is a problem that arises when the action tries to determine which command should be used to launch the documentation build (using poetry or not). I checked the repo `pyansys-dev-guide``and it seems that you have an error but it is not failing the workflow as you are running in Linux, see below

image

However, when I try to use it in a Windows environment here is what I get

image

got it. thank you for the detailed explanation.

@SMoraisAnsys SMoraisAnsys merged commit ceb94ed into main Sep 5, 2024
16 checks passed
@SMoraisAnsys SMoraisAnsys deleted the fix/compatibility-with-examples-repo branch September 5, 2024 10:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Defects or glitches reported by users or developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

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