OCPBUGS-105611: [release-4.22] Fix leading whitespace in Quick Start execute code snippets

[gauron99]

Analysis / Root cause:

The <pre> and <code> tags in the Quick Start {{execute}} code snippet HTML templates are on separate
lines with indentation between them. Since <pre> preserves all whitespace literally, the newline and
spaces between <pre> and <code> render as a visible leading blank line in the code block.

This was fixed on main incidentally by commit 552dc84 (CONSOLE-5434) but never backported to release
branches.

Solution description:

Collapse <pre> and <code> onto a single line in both inline-execute-extension.ts and
multiline-execute-extension.ts, removing the whitespace that <pre> was preserving. This matches what is
already on main.

Screenshots / screen recording:
Before:

After:

Test setup:

1. Cluster running OCP 4.20+ (tested on 4.20.17 via cluster-bot)
2. Run console locally against the cluster using contrib/oc-environment.sh and ./bin/bridge

Test cases:

1. Navigate to Help > Quick Starts > Enable Developer Perspective > Step 4 of 4
2. Verify the oc patch code snippet has no leading blank line
3. Verify the copy button still works
4. Verify other Quick Start steps render correctly

Browser conformance:

• Chrome
• Firefox
• Safari (or Epiphany on Linux)

[openshift-merge-bot]

Pipeline controller notification
This repo is configured to use the pipeline controller. Second-stage tests will be triggered either automatically or after lgtm label is added, depending on the repository configuration. The pipeline controller will automatically detect which contexts are required and will utilize /test Prow commands to trigger the second stage.

For optional jobs, comment /test ? to see a list of all defined jobs. To trigger manually all jobs from second stage use /pipeline required command.

This repository is configured in: LGTM mode

[openshift-ci-robot]

@gauron99: This pull request references Jira Issue OCPBUGS-98159, which is invalid:

• expected the bug to target the "4.22.0" version, but no target version was set
• release note text must be set and not match the template OR release note type must be set to "Release Note Not Required". For more information you can reference the OpenShift Bug Process.
• expected Jira Issue OCPBUGS-98159 to depend on a bug targeting a version in 5.0.0 and in one of the following states: MODIFIED, ON_QA, VERIFIED, but no dependents were found

Comment /jira refresh to re-evaluate validity if changes to the Jira bug are made, or edit the title of this pull request to link to a different bug.

The bug has been updated to refer to the pull request using the external bug tracker.

Details

In response to this:

Analysis / Root cause:

The <pre> and <code> tags in the Quick Start {{execute}} code snippet HTML templates are on separate
lines with indentation between them. Since <pre> preserves all whitespace literally, the newline and
spaces between <pre> and <code> render as a visible leading blank line in the code block.

This was fixed on main incidentally by commit 552dc84 (CONSOLE-5434) but never backported to release
branches.

Solution description:

Collapse <pre> and <code> onto a single line in both inline-execute-extension.ts and
multiline-execute-extension.ts, removing the whitespace that <pre> was preserving. This matches what is
already on main.

Screenshots / screen recording:
Before:

After:

Test setup:

1. Cluster running OCP 4.20+ (tested on 4.20.17 via cluster-bot)
2. Run console locally against the cluster using contrib/oc-environment.sh and ./bin/bridge

Test cases:

1. Navigate to Help > Quick Starts > Enable Developer Perspective > Step 4 of 4
2. Verify the oc patch code snippet has no leading blank line
3. Verify the copy button still works
4. Verify other Quick Start steps render correctly

Browser conformance:

• Chrome
• Firefox
• Safari (or Epiphany on Linux)

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

[gauron99]

/retest ci/prow/backend

[gauron99]

/test backend

[gauron99]

/retest

[gauron99]

/test backend

[gauron99]

/jira cherrypick OCPBUGS-98159

[openshift-ci-robot]

@gauron99: Jira Issue OCPBUGS-98159 has been cloned as Jira Issue OCPBUGS-105611. Will retitle bug to link to clone.
/retitle OCPBUGS-105611: OCPBUGS-98159: [release-4.22] Fix leading whitespace in Quick Start execute code snippets

Details

In response to this:

/jira cherrypick OCPBUGS-98159

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

[openshift-ci-robot]

@gauron99: This pull request references Jira Issue OCPBUGS-105611, which is invalid:

• release note text must be set and not match the template OR release note type must be set to "Release Note Not Required". For more information you can reference the OpenShift Bug Process.
• expected dependent Jira Issue OCPBUGS-98159 to be in one of the following states: MODIFIED, ON_QA, VERIFIED, but it is New instead
• expected dependent Jira Issue OCPBUGS-98159 to target a version in 5.0.0, but no target version was set

Comment /jira refresh to re-evaluate validity if changes to the Jira bug are made, or edit the title of this pull request to link to a different bug.

The bug has been updated to refer to the pull request using the external bug tracker.

Details

In response to this:

Analysis / Root cause:

The <pre> and <code> tags in the Quick Start {{execute}} code snippet HTML templates are on separate
lines with indentation between them. Since <pre> preserves all whitespace literally, the newline and
spaces between <pre> and <code> render as a visible leading blank line in the code block.

This was fixed on main incidentally by commit 552dc84 (CONSOLE-5434) but never backported to release
branches.

Solution description:

Collapse <pre> and <code> onto a single line in both inline-execute-extension.ts and
multiline-execute-extension.ts, removing the whitespace that <pre> was preserving. This matches what is
already on main.

Screenshots / screen recording:
Before:

After:

Test setup:

1. Cluster running OCP 4.20+ (tested on 4.20.17 via cluster-bot)
2. Run console locally against the cluster using contrib/oc-environment.sh and ./bin/bridge

Test cases:

1. Navigate to Help > Quick Starts > Enable Developer Perspective > Step 4 of 4
2. Verify the oc patch code snippet has no leading blank line
3. Verify the copy button still works
4. Verify other Quick Start steps render correctly

Browser conformance:

• Chrome
• Firefox
• Safari (or Epiphany on Linux)

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

[gauron99]

/jira refresh

[openshift-ci-robot]

@gauron99: This pull request references Jira Issue OCPBUGS-105611, which is invalid:

• release note text must be set and not match the template OR release note type must be set to "Release Note Not Required". For more information you can reference the OpenShift Bug Process.
• expected dependent Jira Issue OCPBUGS-98159 to be in one of the following states: MODIFIED, ON_QA, VERIFIED, but it is New instead
• expected dependent Jira Issue OCPBUGS-98159 to target a version in 5.0.0, but no target version was set

Comment /jira refresh to re-evaluate validity if changes to the Jira bug are made, or edit the title of this pull request to link to a different bug.

Details

In response to this:

/jira refresh

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

[gauron99]

/jira refresh

[openshift-ci-robot]

@gauron99: This pull request references Jira Issue OCPBUGS-105611, which is invalid:

• expected dependent Jira Issue OCPBUGS-98159 to be in one of the following states: MODIFIED, ON_QA, VERIFIED, but it is New instead
• expected dependent Jira Issue OCPBUGS-98159 to target a version in 5.0.0, but no target version was set

Comment /jira refresh to re-evaluate validity if changes to the Jira bug are made, or edit the title of this pull request to link to a different bug.

The bug has been updated to refer to the pull request using the external bug tracker.

Details

In response to this:

/jira refresh

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

[gauron99]

/jira refresh

[openshift-ci-robot]

@gauron99: This pull request references Jira Issue OCPBUGS-105611, which is valid. The bug has been moved to the POST state.

7 validation(s) were run on this bug

• bug is open, matching expected state (open)
• bug target version (4.22.0) matches configured target version for branch (4.22.0)
• bug is in the state New, which is one of the valid states (NEW, ASSIGNED, POST)
• release note text is set and does not match the template
• dependent bug Jira Issue OCPBUGS-98159 is in the state MODIFIED, which is one of the valid states (MODIFIED, ON_QA, VERIFIED)
• dependent Jira Issue OCPBUGS-98159 targets the "5.0.0" version, which is one of the valid target versions: 5.0.0
• bug has dependents

Details

In response to this:

/jira refresh

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

[logonoff]

/lgtm

[logonoff]

/label backport-risk-assessed

[openshift-merge-bot]

Scheduling tests matching the pipeline_run_if_changed or not excluded by pipeline_skip_if_only_changed parameters:
/test e2e-gcp-console

[openshift-ci]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: gauron99, logonoff

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details

Needs approval from an approver in each of these files:

• frontend/OWNERS [logonoff]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[gauron99]

/verified by @gauron99

[openshift-ci-robot]

@gauron99: This PR has been marked as verified by @gauron99.

Details

In response to this:

/verified by @gauron99

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

[gauron99]

/retest

[openshift-ci]

@gauron99: all tests passed!

Full PR test history. Your PR dashboard.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

[openshift-ci-robot]

@gauron99: Jira Issue Verification Checks: Jira Issue OCPBUGS-105611
✔️ This pull request was pre-merge verified.
✔️ All associated pull requests have merged.
✔️ All associated, merged pull requests were pre-merge verified.

Jira Issue OCPBUGS-105611 has been moved to the MODIFIED state and will move to the VERIFIED state when the change is available in an accepted nightly payload. 🕓

Details

In response to this:

Analysis / Root cause:

The <pre> and <code> tags in the Quick Start {{execute}} code snippet HTML templates are on separate
lines with indentation between them. Since <pre> preserves all whitespace literally, the newline and
spaces between <pre> and <code> render as a visible leading blank line in the code block.

This was fixed on main incidentally by commit 552dc84 (CONSOLE-5434) but never backported to release
branches.

Solution description:

Collapse <pre> and <code> onto a single line in both inline-execute-extension.ts and
multiline-execute-extension.ts, removing the whitespace that <pre> was preserving. This matches what is
already on main.

Screenshots / screen recording:
Before:

After:

Test setup:

1. Cluster running OCP 4.20+ (tested on 4.20.17 via cluster-bot)
2. Run console locally against the cluster using contrib/oc-environment.sh and ./bin/bridge

Test cases:

1. Navigate to Help > Quick Starts > Enable Developer Perspective > Step 4 of 4
2. Verify the oc patch code snippet has no leading blank line
3. Verify the copy button still works
4. Verify other Quick Start steps render correctly

Browser conformance:

• Chrome
• Firefox
• Safari (or Epiphany on Linux)

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.