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.

Sign up for GitHub

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 pants.log location in docs #20547

Merged
merged 2 commits into from
Feb 14, 2024
Merged

fix pants.log location in docs #20547

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
207b693
fix pants.log location in docs
chris-smith-zocdoc Feb 14, 2024
e5de145
fix the pants.log location in the docs
chris-smith-zocdoc Feb 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/docs/using-pants/using-pants-in-ci.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -237,7 +237,7 @@ attempts_default = 3

## Tip: store Pants logs as artifacts

We recommend that you configure your CI system to store the pants log (`.pantsd.d/pants.log`) as a build artifact, so that it is available in case you need to troubleshoot CI issues.
We recommend that you configure your CI system to store the pants log (`.pants.d/workdir/pants.log`) as a build artifact, so that it is available in case you need to troubleshoot CI issues.

Different CI providers and systems have different ways to configure build artifacts:

Expand Down
6 changes: 3 additions & 3 deletions src/python/pants/engine/streaming_workunit_handler.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -178,9 +178,9 @@ def can_finish_async(self) -> bool:
completed?
The main reason to `return False` is if your callback logs in its final call, when
`finished=True`, as it may end up logging to `.pantsd.d/pants.log` instead of the console,
which is harder for users to find. Otherwise, most callbacks should return `True` to avoid
slowing down Pants from finishing the run.
`finished=True`, as it may end up logging to `.pants.d/workdir/pants.log` instead of the
console, which is harder for users to find. Otherwise, most callbacks should return `True`
to avoid slowing down Pants from finishing the run.
"""


Expand Down
Loading