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

doc: Document build.commands working directory #11218

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

LecrisUT
Copy link

@LecrisUT LecrisUT commented Mar 14, 2024

I just got bit by this trying to do

build:
  commands:
    - cd docs
    - myst build --html

After the cd docs, the next command is reset to the main repo root


📚 Documentation previews 📚

@LecrisUT LecrisUT requested a review from a team as a code owner March 14, 2024 13:38
@LecrisUT LecrisUT requested a review from agjohnson March 14, 2024 13:38
@agjohnson
Copy link
Contributor

Thanks for the note! I agree this is not clear in our docs, so happy to have this clarified.

What is happening here is that each command is run in it's own shell instance. So cd docs alone as a command doesn't affect the working directory of following commands, but also commands like PYTHONPATH=./something also does not affect following commands.

We see confusion around all of the different ways you can trigger this behavior, maybe the note should mention commands running in individual shells instead.

@LecrisUT
Copy link
Author

LecrisUT commented Mar 14, 2024

We see confusion around all of the different ways you can trigger this behavior, maybe the note should mention commands running in individual shells instead.

Agreed. Feel free to take-over and change the wording. I didn't setup my environment for this repo yet.

(Managed to do it with codespace and browser. And now I remember why I gave up on VSCode early on)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants