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

feat(config): Make ignore comments configurable #12917

Merged

Conversation

infraredgirl
Copy link
Contributor

Changes:

When a PR is closed, Renovate posts a comment to let users know
that future updates will be ignored. This change makes contents of that
comment configurable via the config file.

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 tick 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

When a PR is closed, Renovate posts a comment to let users know
that future updates will be ignored. This change makes contents of that
comment configurable via the config file.
Copy link
Collaborator

@rarkins rarkins left a comment

Choose a reason for hiding this comment

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

I'm wondering if it would be better to use an object for this config, like we do with product links:

{
name: 'productLinks',
description: 'Links which are embedded within PRs, issues, etc.',
type: 'object',
globalOnly: true,
mergeable: true,
default: {
documentation: 'https://docs.renovatebot.com/',
help: 'https://github.com/renovatebot/renovate/discussions',
homepage: 'https://github.com/renovatebot/renovate',
},
additionalProperties: {
type: 'string',
format: 'uri',
},
},

It could be called something like userStrings and then have fields like ignoreDigest, ignoreMajor, etc.

@infraredgirl
Copy link
Contributor Author

Thanks for the review!

I'm wondering if it would be better to use an object for this config, like we do with product links

Makes total sense. Fixed in a964e86.

@rarkins rarkins changed the title feat(config): Make ignore comment configurable feat(config): Make ignore comments configurable Dec 8, 2021
@rarkins rarkins enabled auto-merge (squash) December 8, 2021 10:23
@rarkins rarkins merged commit 59026c2 into renovatebot:main Dec 8, 2021
@renovate-release
Copy link
Collaborator

🎉 This PR is included in version 29.36.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jan 8, 2022
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

3 participants