Skip to content

Conversation

@shubhamkd
Copy link

No description provided.

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

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_boxes configuration 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.

Comment on lines +98 to +119

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'
}
}
}
};
Copy link

Copilot AI Dec 30, 2025

Choose a reason for hiding this comment

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

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.

Suggested change
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'
}
}
}
};

Copilot uses AI. Check for mistakes.
Comment on lines +98 to +119

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'
}
}
}
};
Copy link

Copilot AI Dec 30, 2025

Choose a reason for hiding this comment

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

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.

Suggested change
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'
}
}
}
};

Copilot uses AI. Check for mistakes.
</code>
</pre>
</li>
</ul>
Copy link

Copilot AI Dec 30, 2025

Choose a reason for hiding this comment

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

The indentation is inconsistent for this closing ul tag. It should align with the opening ul tag and other list elements.

Suggested change
</ul>
</ul>

Copilot uses AI. Check for mistakes.
</code>
</pre>
</li>
</ul>
Copy link

Copilot AI Dec 30, 2025

Choose a reason for hiding this comment

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

The indentation is inconsistent for this closing ul tag. It should align with the opening ul tag and other list elements.

Copilot uses AI. Check for mistakes.
</li>
</ul>
</td>
</tr>
Copy link

Copilot AI Dec 30, 2025

Choose a reason for hiding this comment

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

There is trailing whitespace at the end of this line after the closing tr tag.

Suggested change
</tr>
</tr>

Copilot uses AI. Check for mistakes.
</li>
</ul>
</td>
</tr>
Copy link

Copilot AI Dec 30, 2025

Choose a reason for hiding this comment

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

There is trailing whitespace at the end of this line after the closing tr tag.

Suggested change
</tr>
</tr>

Copilot uses AI. Check for mistakes.
Comment on lines +453 to +473
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'
}
}
}
};
Copy link

Copilot AI Dec 30, 2025

Choose a reason for hiding this comment

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

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.

Suggested change
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'
}
}
}
};

Copilot uses AI. Check for mistakes.
Comment on lines +452 to +473

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'
}
}
}
};
Copy link

Copilot AI Dec 30, 2025

Choose a reason for hiding this comment

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

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.

Suggested change
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'
}
}
}
};

Copilot uses AI. Check for mistakes.
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.

1 participant