Skip to content

Commit

Permalink
fix pants.log location in docs (pantsbuild#20547)
Browse files Browse the repository at this point in the history
Update the `pants.log` file location after the changes in
pantsbuild#19911
  • Loading branch information
chris-smith-zocdoc authored Feb 14, 2024
1 parent d782c03 commit d82c578
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion docs/docs/using-pants/using-pants-in-ci.mdx
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
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

0 comments on commit d82c578

Please sign in to comment.