Add steps to resolve missing line break issues when running tests in parallel mode in CI environments #364
Conversation
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive documentation to help users resolve missing line break issues that occur when running Nightwatch tests in parallel mode within CI environments. The documentation introduces the disable_output_boxes configuration setting and provides clear examples of how to use it.
Key Changes
- Added documentation for the
disable_output_boxesconfiguration setting with detailed examples showing two configuration approaches - Added warning notices across all CI integration documentation pages pointing users to the solution
- Cross-linked the parallel running guide with the configuration documentation
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 8 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/guide/running-tests/parallel-running.md | Added warning box directing users to the disable_output_boxes setting for CI line break issues |
| docs/guide/reference/settings.md | Added comprehensive documentation entry for disable_output_boxes with examples and known issue details |
| docs/guide/configuration/customising-test-output.md | Added comprehensive documentation entry for disable_output_boxes with examples and known issue details |
| docs/guide/ci-integrations/run-nightwatch-on-jenkins.md | Added warning box directing users to the disable_output_boxes setting |
| docs/guide/ci-integrations/run-nightwatch-on-gitlab.md | Added warning box directing users to the disable_output_boxes setting |
| docs/guide/ci-integrations/run-nightwatch-on-github-actions.md | Added warning box directing users to the disable_output_boxes setting |
| docs/guide/ci-integrations/run-nightwatch-on-circleci.md | Added warning box directing users to the disable_output_boxes setting |
| docs/guide/ci-integrations/run-nightwatch-on-bamboo.md | Added warning box directing users to the disable_output_boxes setting |
| docs/guide/ci-integrations/run-nightwatch-on-azure-pipelines.md | Added warning box directing users to the disable_output_boxes setting |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| test_settings: { | ||
| default: { | ||
| // ... your settings | ||
| } | ||
| } | ||
| }; | ||
| </code> | ||
| </pre> | ||
| </li> | ||
| <li>Set <code>disable_output_boxes: true</code> inside a specific environment object (e.g., inside the <code>chrome</code> environment if you use separate environments for CI):<br><pre data-language="javascript"><code class="language-javascript">module.exports = { | ||
| src_folders: ['tests'], | ||
|
|
||
| test_settings: { | ||
| chrome: { | ||
| disable_output_boxes: true, | ||
| desiredCapabilities: { | ||
| browserName: 'chrome' | ||
| } | ||
| } | ||
| } | ||
| }; |
There was a problem hiding this comment.
The indentation in this code example is inconsistent. The test_settings property should be aligned with src_folders and disable_output_boxes at the same level, not indented further.
| test_settings: { | |
| default: { | |
| // ... your settings | |
| } | |
| } | |
| }; | |
| </code> | |
| </pre> | |
| </li> | |
| <li>Set <code>disable_output_boxes: true</code> inside a specific environment object (e.g., inside the <code>chrome</code> environment if you use separate environments for CI):<br><pre data-language="javascript"><code class="language-javascript">module.exports = { | |
| src_folders: ['tests'], | |
| test_settings: { | |
| chrome: { | |
| disable_output_boxes: true, | |
| desiredCapabilities: { | |
| browserName: 'chrome' | |
| } | |
| } | |
| } | |
| }; | |
| test_settings: { | |
| default: { | |
| // ... your settings | |
| } | |
| } | |
| }; | |
| </code> | |
| </pre> | |
| </li> | |
| <li>Set <code>disable_output_boxes: true</code> inside a specific environment object (e.g., inside the <code>chrome</code> environment if you use separate environments for CI):<br><pre data-language="javascript"><code class="language-javascript">module.exports = { | |
| src_folders: ['tests'], | |
| test_settings: { | |
| chrome: { | |
| disable_output_boxes: true, | |
| desiredCapabilities: { | |
| browserName: 'chrome' | |
| } | |
| } | |
| } | |
| }; |
|
|
||
| test_settings: { | ||
| default: { | ||
| // ... your settings | ||
| } | ||
| } | ||
| }; | ||
| </code> | ||
| </pre> | ||
| </li> | ||
| <li>Set <code>disable_output_boxes: true</code> inside a specific environment object (e.g., inside the <code>chrome</code> environment if you use separate environments for CI):<br><pre data-language="javascript"><code class="language-javascript">module.exports = { | ||
| src_folders: ['tests'], | ||
|
|
||
| test_settings: { | ||
| chrome: { | ||
| disable_output_boxes: true, | ||
| desiredCapabilities: { | ||
| browserName: 'chrome' | ||
| } | ||
| } | ||
| } | ||
| }; |
There was a problem hiding this comment.
The indentation in this code example is inconsistent. The test_settings property should be aligned with src_folders at the same level, not indented further.
| test_settings: { | |
| default: { | |
| // ... your settings | |
| } | |
| } | |
| }; | |
| </code> | |
| </pre> | |
| </li> | |
| <li>Set <code>disable_output_boxes: true</code> inside a specific environment object (e.g., inside the <code>chrome</code> environment if you use separate environments for CI):<br><pre data-language="javascript"><code class="language-javascript">module.exports = { | |
| src_folders: ['tests'], | |
| test_settings: { | |
| chrome: { | |
| disable_output_boxes: true, | |
| desiredCapabilities: { | |
| browserName: 'chrome' | |
| } | |
| } | |
| } | |
| }; | |
| test_settings: { | |
| default: { | |
| // ... your settings | |
| } | |
| } | |
| }; | |
| </code> | |
| </pre> | |
| </li> | |
| <li>Set <code>disable_output_boxes: true</code> inside a specific environment object (e.g., inside the <code>chrome</code> environment if you use separate environments for CI):<br><pre data-language="javascript"><code class="language-javascript">module.exports = { | |
| src_folders: ['tests'], | |
| test_settings: { | |
| chrome: { | |
| disable_output_boxes: true, | |
| desiredCapabilities: { | |
| browserName: 'chrome' | |
| } | |
| } | |
| } | |
| }; |
docs/guide/reference/settings.md
Outdated
| </code> | ||
| </pre> | ||
| </li> | ||
| </ul> |
There was a problem hiding this comment.
The indentation is inconsistent for this closing ul tag. It should align with the opening ul tag and other list elements.
| </ul> | |
| </ul> |
| </code> | ||
| </pre> | ||
| </li> | ||
| </ul> |
There was a problem hiding this comment.
The indentation is inconsistent for this closing ul tag. It should align with the opening ul tag and other list elements.
docs/guide/reference/settings.md
Outdated
| test_settings: { | ||
| default: { | ||
| // ... your settings | ||
| } | ||
| } | ||
| }; | ||
| </code> | ||
| </pre> | ||
| </li> | ||
| <li>Set <code>disable_output_boxes: true</code> inside a specific environment object (e.g., inside the <code>chrome</code> environment if you use separate environments for CI):<br><pre data-language="javascript"><code class="language-javascript">module.exports = { | ||
| src_folders: ['tests'], | ||
|
|
||
| test_settings: { | ||
| chrome: { | ||
| disable_output_boxes: true, | ||
| desiredCapabilities: { | ||
| browserName: 'chrome' | ||
| } | ||
| } | ||
| } | ||
| }; |
There was a problem hiding this comment.
The indentation in this code example is inconsistent. The test_settings property should be aligned with src_folders and disable_output_boxes at the same level, not indented further.
| test_settings: { | |
| default: { | |
| // ... your settings | |
| } | |
| } | |
| }; | |
| </code> | |
| </pre> | |
| </li> | |
| <li>Set <code>disable_output_boxes: true</code> inside a specific environment object (e.g., inside the <code>chrome</code> environment if you use separate environments for CI):<br><pre data-language="javascript"><code class="language-javascript">module.exports = { | |
| src_folders: ['tests'], | |
| test_settings: { | |
| chrome: { | |
| disable_output_boxes: true, | |
| desiredCapabilities: { | |
| browserName: 'chrome' | |
| } | |
| } | |
| } | |
| }; | |
| test_settings: { | |
| default: { | |
| // ... your settings | |
| } | |
| } | |
| }; | |
| </code> | |
| </pre> | |
| </li> | |
| <li>Set <code>disable_output_boxes: true</code> inside a specific environment object (e.g., inside the <code>chrome</code> environment if you use separate environments for CI):<br><pre data-language="javascript"><code class="language-javascript">module.exports = { | |
| src_folders: ['tests'], | |
| test_settings: { | |
| chrome: { | |
| disable_output_boxes: true, | |
| desiredCapabilities: { | |
| browserName: 'chrome' | |
| } | |
| } | |
| } | |
| }; |
docs/guide/reference/settings.md
Outdated
|
|
||
| test_settings: { | ||
| default: { | ||
| // ... your settings | ||
| } | ||
| } | ||
| }; | ||
| </code> | ||
| </pre> | ||
| </li> | ||
| <li>Set <code>disable_output_boxes: true</code> inside a specific environment object (e.g., inside the <code>chrome</code> environment if you use separate environments for CI):<br><pre data-language="javascript"><code class="language-javascript">module.exports = { | ||
| src_folders: ['tests'], | ||
|
|
||
| test_settings: { | ||
| chrome: { | ||
| disable_output_boxes: true, | ||
| desiredCapabilities: { | ||
| browserName: 'chrome' | ||
| } | ||
| } | ||
| } | ||
| }; |
There was a problem hiding this comment.
The indentation in this code example is inconsistent. The test_settings property should be aligned with src_folders at the same level, not indented further.
| test_settings: { | |
| default: { | |
| // ... your settings | |
| } | |
| } | |
| }; | |
| </code> | |
| </pre> | |
| </li> | |
| <li>Set <code>disable_output_boxes: true</code> inside a specific environment object (e.g., inside the <code>chrome</code> environment if you use separate environments for CI):<br><pre data-language="javascript"><code class="language-javascript">module.exports = { | |
| src_folders: ['tests'], | |
| test_settings: { | |
| chrome: { | |
| disable_output_boxes: true, | |
| desiredCapabilities: { | |
| browserName: 'chrome' | |
| } | |
| } | |
| } | |
| }; | |
| test_settings: { | |
| default: { | |
| // ... your settings | |
| } | |
| } | |
| }; | |
| </code> | |
| </pre> | |
| </li> | |
| <li>Set <code>disable_output_boxes: true</code> inside a specific environment object (e.g., inside the <code>chrome</code> environment if you use separate environments for CI):<br><pre data-language="javascript"><code class="language-javascript">module.exports = { | |
| src_folders: ['tests'], | |
| test_settings: { | |
| chrome: { | |
| disable_output_boxes: true, | |
| desiredCapabilities: { | |
| browserName: 'chrome' | |
| } | |
| } | |
| } | |
| }; |
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 9 out of 9 changed files in this pull request and generated 14 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| <td>false</td> | ||
| <td>Set this to true if you'd like to disable bounding boxes on terminal output.<br> <strong>Known Issue:</strong> When running tests in parallel mode in CI environments (such as GitLab CI), line breaks may be missing from the output, making it difficult to read. This issue does not occur when running locally. See <a href="https://github.com/nightwatchjs/nightwatch/issues/4396" target="_blank">issue #4396</a> for more details. | ||
| </td> | ||
| </tr> |
There was a problem hiding this comment.
This line has trailing whitespace. Remove the trailing spaces at the end of the line for consistent code formatting.
| </tr> | |
| </tr> |
docs/guide/ci-integrations/run-nightwatch-on-azure-pipelines.md
Outdated
Show resolved
Hide resolved
| <div class="alert alert-warning"> | ||
| If you're experiencing missing line breaks in the output when running tests in parallel mode in CI environments (such as GitLab CI), see the <code>disable_output_boxes</code> output setting in the <a href="/guide/configuration/customising-test-output.html">Test Output</a> page to resolve this. | ||
| </div> |
There was a problem hiding this comment.
The closing div tag is missing for this alert box. The HTML structure should have a closing </div> tag to properly close the alert-warning div that was opened on line 78.
| <div class="alert alert-warning"> | ||
| If you're experiencing missing line breaks in the output when running tests in parallel mode in CI environments, see the <code>disable_output_boxes</code> output setting in the <a href="/guide/configuration/customising-test-output.html">Test Output</a> page to resolve this. | ||
| </div> |
There was a problem hiding this comment.
The closing div tag is missing for this alert box. The HTML structure should have a closing </div> tag to properly close the alert-warning div that was opened on line 125.
| <div class="alert alert-warning"> | ||
| If you're experiencing missing line breaks in the output when running tests in parallel mode in CI environments, see the <code>disable_output_boxes</code> output setting in the <a href="/guide/configuration/customising-test-output.html">Test Output</a> page to resolve this. | ||
| </div> |
There was a problem hiding this comment.
The closing div tag is missing for this alert box. The HTML structure should have a closing </div> tag to properly close the alert-warning div that was opened on line 80.
| <div class="alert alert-warning"> | ||
| If you're experiencing missing line breaks in the output when running tests in parallel mode in CI environments, see the <code>disable_output_boxes</code> output setting in the <a href="/guide/configuration/customising-test-output.html">Test Output</a> page to resolve this. | ||
| </div> |
There was a problem hiding this comment.
The closing div tag is missing for this alert box. The HTML structure should have a closing </div> tag to properly close the alert-warning div that was opened on line 72.
| <div class="alert alert-warning"> | ||
| If you're experiencing missing line breaks in the output when running tests in parallel mode in CI environments, see the <code>disable_output_boxes</code> output setting in the <a href="/guide/configuration/customising-test-output.html">Test Output</a> page to resolve this. | ||
| </div> |
There was a problem hiding this comment.
The closing div tag is missing for this alert box. The HTML structure should have a closing </div> tag to properly close the alert-warning div that was opened on line 76.
| <div class="alert alert-warning"> | ||
| If you're experiencing missing line breaks in the output when running tests in parallel mode in CI environments, see the <code>disable_output_boxes</code> output setting in the <a href="/guide/configuration/customising-test-output.html">Test Output</a> page to resolve this. | ||
| </div> |
There was a problem hiding this comment.
The closing div tag is missing for this alert box. The HTML structure should have a closing </div> tag to properly close the alert-warning div that was opened on line 92.
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 9 out of 9 changed files in this pull request and generated 3 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| <div class="alert alert-warning"> | ||
| <strong>Known Issue:</strong> When running tests in parallel mode in CI environments, line breaks may be missing from the output, making it difficult to read. See the <code>disable_output_boxes</code> output setting in the <a href="/guide/configuration/customising-test-output.html">Test Output</a> page to resolve this. | ||
| </div> | ||
| Related articles |
There was a problem hiding this comment.
Missing section heading markup. The text "Related articles" should be formatted as a heading with "###" prefix to be consistent with other sections in the documentation.
| <td><code>disable_output_boxes</code></td> | ||
| <td>boolean</td> | ||
| <td>false</td> | ||
| <td>Set this to true if you'd like to disable bounding boxes on terminal output.</td> |
There was a problem hiding this comment.
The description "Set this to true if you'd like to disable bounding boxes on terminal output" doesn't clearly explain what "bounding boxes" means or how this relates to the line break issue mentioned in the warning messages throughout the documentation. Consider a more descriptive explanation that connects this setting to the issue it resolves, such as "Set this to true to disable bounding boxes around terminal output sections. This can resolve missing line break issues in CI environments when running tests in parallel mode."
| <td>Set this to true if you'd like to disable bounding boxes on terminal output.</td> | |
| <td>Set this to true to disable bounding boxes around terminal output sections. This can resolve missing line break issues in CI environments when running tests in parallel mode.</td> |
| <td><code>disable_output_boxes</code></td> | ||
| <td>boolean</td> | ||
| <td>false</td> | ||
| <td>Set this to true if you'd like to disable bounding boxes on terminal output.</td> |
There was a problem hiding this comment.
The description "Set this to true if you'd like to disable bounding boxes on terminal output" doesn't clearly explain what "bounding boxes" means or how this relates to the line break issue mentioned in the warning message. Consider a more descriptive explanation that connects this setting to the issue it resolves, such as "Set this to true to disable bounding boxes around terminal output sections. This can resolve missing line break issues in CI environments when running tests in parallel mode."
| <td>Set this to true if you'd like to disable bounding boxes on terminal output.</td> | |
| <td>Set this to true to disable bounding boxes around terminal output sections. This can resolve missing line break issues in CI environments when running tests in parallel mode.</td> |
1 participant
Issue: nightwatchjs/nightwatch#4396
