Require changelog entry when conf.yaml.example changes#23655
Conversation
|
|
|
This PR does not modify any files shipped with the agent. To help streamline the release process, please consider adding the |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files🚀 New features to boost your workflow:
|
|
✨ Fix all issues with BitsAI or with Cursor
|
Validation ReportAll 20 validations passed. Show details
|
What does this PR do?
example_configcached property toIntegrationthat returns the expected path of the integration'sconf.yaml.examplefile (under<package_directory>/data/).Integration.requires_changelog_entryso it now also returnsTruewhen the modified file is the example config.Motivation
Follow-up to feedback on #23652: the rule for whether a change requires a changelog entry is no longer just "is it a code file or
pyproject.toml" — anything shipped with the Agent needs a changelog entry, including the example configuration file. Surfacingexample_configas a property onIntegrationalso gives other callers a single place to ask for that path instead of hardcoding it.Review checklist (to be filled by reviewers)
qa/skip-qalabel if the PR doesn't need to be tested during QA.backport/<branch-name>label to the PR and it will automatically open a backport PR once this one is merged