chore: Tweak APPROVALNOTIFIER markdown template to render consistent HTML #1639

azuwis · 2025-01-07T14:37:39Z

Currently the rendered HTML on gitlab is confusing:

This pull-request has been approved by: To complete the pull request process, please assign <user> You can assign the PR to them by writing /lh-assign @<user> in a comment when ready.

The above content are in one paragraph without new lines or ..

Tweak according to CommonMark Spec, since both GitHub Flavored Markdown Spec and GitLab Flavored Markdown are based on it.

Gitlab before:

Gitlab after:

jenkins-x-bot · 2025-01-07T14:37:54Z

Hi @azuwis. Thanks for your PR.

I'm waiting for a jenkins-x member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

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 jenkins-x/lighthouse repository.

msvticket · 2025-01-07T15:19:39Z

/ok-to-test

msvticket

Tests need to be updated accordingly. Run make test

azuwis · 2025-01-10T07:07:03Z

@msvticket Tests are fixed. Also modified the markdown so that the generate HTML on Github will be exact the same before this change.

msvticket

To me it doesn't look like the change is matching the images in the description of this PR

azuwis · 2025-01-10T10:42:12Z

The problem

Github does not handle the soft line breaks correctly defined by it's own GitHub Flavored Markdown Spec https://github.github.com/gfm/#soft-line-breaks, it treats soft line breaks and hard line breaks as the same thing.

Gitlab does the right thing, https://about.gitlab.com/blog/2014/02/21/markdown-newline-behaviour/, https://gitlab.com/gitlab-org/gitlab-foss/-/issues/57809, and is different from Github.

The fix

Use hard line breaks, so both Github and Gitlab are happy.

Details

Generate the markdown

Before

Use https://go.dev/play/p/35RYE-Nkkh8 to generate, copied from

lighthouse/pkg/plugins/approve/approvers/approvers_test.go

Lines 711 to 730 in efe21a2

    
           	want := `[APPROVALNOTIFIER] This PR is **NOT APPROVED** 
        
           This pull-request has been approved by: *[Bill](REFERENCE "Approved")* 
        
           To complete the [pull request process](https://git.k8s.io/community/contributors/guide/owners.md#the-code-review-process), please assign **alice** 
        
           You can assign the PR to them by writing ` + "`/assign @alice`" + ` in a comment when ready. 
        
           *No associated issue*. Update pull-request body to add a reference to an issue, or get approval with ` + "`/approve no-issue`" + ` 
        
           The full list of commands accepted by this bot can be found [here](https://jenkins-x.io/v3/develop/reference/chatops/?repo=org%2Frepo). 
        
           <details open> 
        
           Needs approval from an approver in each of these files: 
        
           - **[a/OWNERS](https://github.com/org/repo/blob/dev/a/OWNERS)** 
        
           - ~~[b/OWNERS](https://github.com/org/repo/blob/dev/b/OWNERS)~~ [Bill] 
        
           Approvers can indicate their approval by writing ` + "`/approve`" + ` in a comment 
        
           Approvers can cancel approval by writing ` + "`/approve cancel`" + ` in a comment 
        
           </details> 
        
           <!-- META={"approvers":["alice"]} -->`

:

[APPROVALNOTIFIER] This PR is **NOT APPROVED**

This pull-request has been approved by: *[Bill](REFERENCE "Approved")*
To complete the [pull request process](https://git.k8s.io/community/contributors/guide/owners.md#the-code-review-process), please assign **alice**
You can assign the PR to them by writing `/assign @alice` in a comment when ready.

*No associated issue*. Update pull-request body to add a reference to an issue, or get approval with `/approve no-issue`

The full list of commands accepted by this bot can be found [here](https://jenkins-x.io/v3/develop/reference/chatops/?repo=org%2Frepo).

<details open>
Needs approval from an approver in each of these files:

- **[a/OWNERS](https://github.com/org/repo/blob/dev/a/OWNERS)**
- ~~[b/OWNERS](https://github.com/org/repo/blob/dev/b/OWNERS)~~ [Bill]

Approvers can indicate their approval by writing `/approve` in a comment
Approvers can cancel approval by writing `/approve cancel` in a comment
</details>
<!-- META={"approvers":["alice"]} -->

After

Use https://go.dev/play/p/YlXcBuaHj0H to generate, copied from

lighthouse/pkg/plugins/approve/approvers/approvers_test.go

Lines 711 to 730 in 8b4b164

    
           	want := `[APPROVALNOTIFIER] This PR is **NOT APPROVED** 
        
           This pull-request has been approved by: *[Bill](REFERENCE "Approved")*   
        
           To complete the [pull request process](https://git.k8s.io/community/contributors/guide/owners.md#the-code-review-process), please assign **alice**   
        
           You can assign the PR to them by writing ` + "`/assign @alice`" + ` in a comment when ready. 
        
           *No associated issue*. Update pull-request body to add a reference to an issue, or get approval with ` + "`/approve no-issue`" + ` 
        
           The full list of commands accepted by this bot can be found [here](https://jenkins-x.io/v3/develop/reference/chatops/?repo=org%2Frepo). 
        
           <details open> 
        
           Needs approval from an approver in each of these files: 
        
           - **[a/OWNERS](https://github.com/org/repo/blob/dev/a/OWNERS)** 
        
           - ~~[b/OWNERS](https://github.com/org/repo/blob/dev/b/OWNERS)~~ [Bill] 
        
           Approvers can indicate their approval by writing ` + "`/approve`" + ` in a comment 
        
           Approvers can cancel approval by writing ` + "`/approve cancel`" + ` in a comment 
        
           </details> 
        
           <!-- META={"approvers":["alice"]} -->`

:

[APPROVALNOTIFIER] This PR is **NOT APPROVED**

This pull-request has been approved by: *[Bill](REFERENCE "Approved")*  
To complete the [pull request process](https://git.k8s.io/community/contributors/guide/owners.md#the-code-review-process), please assign **alice**  
You can assign the PR to them by writing `/assign @alice` in a comment when ready.

*No associated issue*. Update pull-request body to add a reference to an issue, or get approval with `/approve no-issue`

The full list of commands accepted by this bot can be found [here](https://jenkins-x.io/v3/develop/reference/chatops/?repo=org%2Frepo).

<details open>
Needs approval from an approver in each of these files:

- **[a/OWNERS](https://github.com/org/repo/blob/dev/a/OWNERS)**
- ~~[b/OWNERS](https://github.com/org/repo/blob/dev/b/OWNERS)~~ [Bill]

Approvers can indicate their approval by writing `/approve` in a comment
Approvers can cancel approval by writing `/approve cancel` in a comment
</details>
<!-- META={"approvers":["alice"]} -->

Rendered on Github

Before

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: Bill
To complete the pull request process, please assign alice
You can assign the PR to them by writing /assign @alice in a comment when ready.

No associated issue. Update pull-request body to add a reference to an issue, or get approval with /approve no-issue

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

Needs approval from an approver in each of these files:

a/OWNERS
~~b/OWNERS~~ [Bill]

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

After

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: Bill
To complete the pull request process, please assign alice
You can assign the PR to them by writing /assign @alice in a comment when ready.

No associated issue. Update pull-request body to add a reference to an issue, or get approval with /approve no-issue

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

Needs approval from an approver in each of these files:

a/OWNERS
~~b/OWNERS~~ [Bill]

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

Render on Gitlab

Copy the markdown, and preview on any Gitlab issue.

Before

After

Conclusion

The rendered HTML on Github is exact the same before and after this change.

The rendered HTML on Gitlab is confusing before this change, and give similar result as Github after.

jenkins-x-bot · 2025-01-10T11:21:00Z