Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Changelog containing '</details>' breaks pr formatting #10143

Closed
3 of 15 tasks
Tracked by #14138
dsbert opened this issue May 25, 2021 · 14 comments
Closed
3 of 15 tasks
Tracked by #14138

Changelog containing '</details>' breaks pr formatting #10143

dsbert opened this issue May 25, 2021 · 14 comments
Labels
core:changelogs Related to changelogs/release notes fetching priority-3-medium Default priority, "should be done" but isn't prioritised ahead of others status:requirements Full requirements are not yet known, so implementation should not be started type:bug Bug fix of existing functionality

Comments

@dsbert
Copy link

dsbert commented May 25, 2021

How are you running Renovate?

  • WhiteSource Renovate hosted app on github.com
  • Self hosted

If using the hosted app, please skip to the next section.
Otherwise, if self-hosted, please complete the following:

Please select which platform you are using:

  • Azure DevOps (dev.azure.com)
  • Azure DevOps Server
  • Bitbucket Cloud (bitbucket.org)
  • Bitbucket Server
  • Gitea
  • github.com
  • GitHub Enterprise Server
  • gitlab.com
  • GitLab self-hosted

Renovate version: 25.21.12

Describe the bug

The renovate changelog contains </details>. This is not escaped so when the PR is created, the collapsed changelog formatting breaks. This could happen with any other project obviously, but this projects changelog is an easy example. I'm not sure if it makes sense to scan the changelogs and escape this everywhere, but it might at least make sense to escape that somehow in this specific changelog.

...

Relevant debug logs

Have you created a minimal reproduction repository?

Please read the minimal reproductions documentation to learn how to make a good minimal reproduction repository.

  • I have provided a minimal reproduction repository
  • I don't have time for that, but it happens in a public repository I have linked to
  • I don't have time for that, and cannot share my private repository
  • The nature of this bug means it's impossible to reproduce publicly

https://gitlab.com/dsbert/renovate-bot/-/merge_requests/2

Additional context

image

@dsbert dsbert added priority-5-triage status:requirements Full requirements are not yet known, so implementation should not be started type:bug Bug fix of existing functionality labels May 25, 2021
@rarkins rarkins added auto:reproduction A minimal reproduction is necessary to proceed priority-3-medium Default priority, "should be done" but isn't prioritised ahead of others and removed priority-5-triage labels May 25, 2021
@github-actions
Copy link
Contributor

Hi there,

The Renovate team needs your help! Before we can start work on your issue we first need to know exactly what's causing the current behavior. A minimal reproduction helps us with this.

To get started, please read our guide on minimal reproductions to understand what is needed.

We may close the issue if you have not provided a minimal reproduction within two weeks. If you need more time, or are stuck, please ask for help or more time in a comment.

Good luck,

The Renovate team

@rarkins
Copy link
Collaborator

rarkins commented May 25, 2021

Are you aware of any open source package which has included this in a recent changelog?

@dsbert
Copy link
Author

dsbert commented May 25, 2021

@viceice
Copy link
Member

viceice commented May 25, 2021

I think this is already fixed in newer renovate 80e3e6a, so please update to v25.26.5 or higher

@viceice
Copy link
Member

viceice commented May 25, 2021

You should also checkout our gitlab pipeline templates for at https://gitlab.com/renovate-bot/renovate-runner

@viceice viceice added reproduction:confirmed and removed auto:reproduction A minimal reproduction is necessary to proceed labels May 25, 2021
@dsbert
Copy link
Author

dsbert commented May 25, 2021

@viceice Thanks, but I'm currently using a private gitlab instance with Jenkins as my runner in a corporate environment. The repo above is just a quick one I threw together to demonstrate.

@rarkins
Copy link
Collaborator

rarkins commented May 25, 2021

Which version did you run?

@HonkingGoose

This comment has been minimized.

@dsbert
Copy link
Author

dsbert commented May 26, 2021

I ran it again with a local version of [email protected] and the result is the same, so I do not think this issue has been resolved.

@viceice
Copy link
Member

viceice commented May 26, 2021

@dsbert Did you checked the rebase checkbox before you run with latest version, so renovate did a force update?

@rarkins
Copy link
Collaborator

rarkins commented May 26, 2021

I think Renovate will always update PR bodies regardless of whether it's rebasing

@dsbert
Copy link
Author

dsbert commented May 26, 2021

I actually deleted the old pr completely so it definitely updated.

@github-actions
Copy link
Contributor

Thank you for providing a reproduction! 🎉 🚀

The Renovate team will take a look at the reproduction repository. Once we confirm the provided repository reproduces the problem, the label will be changed to reproduction:confirmed.

@HonkingGoose HonkingGoose added the core:changelogs Related to changelogs/release notes fetching label Sep 1, 2021
@viceice
Copy link
Member

viceice commented Feb 10, 2022

Is this still an issue?

@rarkins rarkins closed this as completed Feb 11, 2022
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 14, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
core:changelogs Related to changelogs/release notes fetching priority-3-medium Default priority, "should be done" but isn't prioritised ahead of others status:requirements Full requirements are not yet known, so implementation should not be started type:bug Bug fix of existing functionality
Projects
None yet
Development

No branches or pull requests

4 participants