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

fix(template): Proxy Compile Input loses values from arrays #21943

Conversation

tekerson
Copy link
Contributor

@tekerson tekerson commented May 3, 2023

Changes

This change prevents the values in Array<string> inputs (e.g. prBodyNotes) from being stripped by the proxyCompileInput / allowed fields process.

Context

I was trying to implement a "fallback" rule that provides general instructions if there aren't any other rules in place. Based on the documentation, I believe something like this should work.

        {
            "matchPackagePatterns": ["*"],
            "prBodyNotes": `{{#unless prBodyNotes}}Only show this if there aren't more specific configurations{{/unless}}`
        }

Unfortunately, it rendered the fallback message even when another rule (that includes prBodyNotes) matches, indicating that the prBodyNotes value is not being supplied in the template context.

After having a look at the implementation and tests, I believe it is because the proxyCompileInput is dropping the values in prBodyNotes when it attempts to recurse into the array. I don't believe this is intentional, as prBodyNotes (et al) is listed in the exposedConfigOptions.

Documentation (please check one with an [x])

  • I have updated the documentation, or
  • No documentation update is required

How I've tested my work (please select one)

I have verified these changes via:

  • Code inspection only, or
  • Newly added/modified unit tests, or
  • No unit tests but ran on a real repository, or
  • Both unit tests + ran on a real repository

@rarkins rarkins added this pull request to the merge queue May 3, 2023
Merged via the queue into renovatebot:main with commit 0913787 May 3, 2023
11 checks passed
@renovate-release
Copy link
Collaborator

🎉 This PR is included in version 35.69.4 🎉

The release is available on:

Your semantic-release bot 📦🚀

mjunker pushed a commit to mjunker/renovate that referenced this pull request May 17, 2023
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jun 3, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants