Skip to content

Require changelog entry when conf.yaml.example changes#23655

Merged
AAraKKe merged 3 commits into
masterfrom
aarakke/ddev-changelog-example-config
May 12, 2026
Merged

Require changelog entry when conf.yaml.example changes#23655
AAraKKe merged 3 commits into
masterfrom
aarakke/ddev-changelog-example-config

Conversation

@AAraKKe

@AAraKKe AAraKKe commented May 10, 2026

Copy link
Copy Markdown
Collaborator

What does this PR do?

  • Adds an example_config cached property to Integration that returns the expected path of the integration's conf.yaml.example file (under <package_directory>/data/).
  • Extends Integration.requires_changelog_entry so it now also returns True when 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. Surfacing example_config as a property on Integration also gives other callers a single place to ask for that path instead of hardcoding it.

Review checklist (to be filled by reviewers)

  • Feature or bugfix MUST have appropriate tests (unit, integration, e2e)
  • Add the qa/skip-qa label if the PR doesn't need to be tested during QA.
  • If you need to backport this PR to another branch, you can add the backport/<branch-name> label to the PR and it will automatically open a backport PR once this one is merged

@AAraKKe AAraKKe added the qa/skip-qa Automatically skip this PR for the next QA label May 10, 2026
@dd-octo-sts dd-octo-sts Bot added ddev and removed qa/skip-qa Automatically skip this PR for the next QA labels May 10, 2026
@AAraKKe AAraKKe marked this pull request as ready for review May 10, 2026 22:00
@AAraKKe AAraKKe requested a review from a team as a code owner May 10, 2026 22:00
@github-actions

Copy link
Copy Markdown
Contributor

⚠️ Major version bump
The changelog type changed or removed was used in this Pull Request, so the next release will bump major version. Please make sure this is a breaking change, or use the fixed or added type instead.

@dd-octo-sts

dd-octo-sts Bot commented May 10, 2026

Copy link
Copy Markdown
Contributor

⚠️ Recommendation: Add qa/skip-qa label

This PR does not modify any files shipped with the agent.

To help streamline the release process, please consider adding the qa/skip-qa label if these changes do not require QA testing.

@codecov

codecov Bot commented May 10, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.86%. Comparing base (cc7e7b5) to head (cfa07c5).

Additional details and impacted files
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@datadog-prod-us1-4

datadog-prod-us1-4 Bot commented May 10, 2026

Copy link
Copy Markdown
Contributor

Tests

Fix all issues with BitsAI or with Cursor

⚠️ Warnings

🧪 11 Tests failed

test_build_event from test_teamcity.py   View in Datadog   (Fix with Cursor)
RetryError[<Future at 0x7f897473d950 state=finished raised SubprocessError>]
test_collect_build_problems from test_teamcity.py   View in Datadog   (Fix with Cursor)
RetryError[<Future at 0x7f897473d950 state=finished raised SubprocessError>]
test_collect_build_stats from test_teamcity.py   View in Datadog   (Fix with Cursor)
RetryError[<Future at 0x7f897473d950 state=finished raised SubprocessError>]
View all

ℹ️ Info

No other issues found (see more)

❄️ No new flaky tests detected

🎯 Code Coverage (details)
Patch Coverage: 100.00%
Overall Coverage: 87.37% (+0.12%)

Useful? React with 👍 / 👎

This comment will be updated automatically if new data arrives.
🔗 Commit SHA: cfa07c5 | Docs | Datadog PR Page | Give us feedback!

@dd-octo-sts

dd-octo-sts Bot commented May 12, 2026

Copy link
Copy Markdown
Contributor

Validation Report

All 20 validations passed.

Show details
Validation Description Status
agent-reqs Verify check versions match the Agent requirements file
ci Validate CI configuration and Codecov settings
codeowners Validate every integration has a CODEOWNERS entry
config Validate default configuration files against spec.yaml
dep Verify dependency pins are consistent and Agent-compatible
http Validate integrations use the HTTP wrapper correctly
imports Validate check imports do not use deprecated modules
integration-style Validate check code style conventions
jmx-metrics Validate JMX metrics definition files and config
labeler Validate PR labeler config matches integration directories
legacy-signature Validate no integration uses the legacy Agent check signature
license-headers Validate Python files have proper license headers
licenses Validate third-party license attribution list
metadata Validate metadata.csv metric definitions
models Validate configuration data models match spec.yaml
openmetrics Validate OpenMetrics integrations disable the metric limit
package Validate Python package metadata and naming
readmes Validate README files have required sections
saved-views Validate saved view JSON file structure and fields
version Validate version consistency between package and changelog

View full run

@AAraKKe AAraKKe added this pull request to the merge queue May 12, 2026
Merged via the queue into master with commit 304819d May 12, 2026
362 of 365 checks passed
@AAraKKe AAraKKe deleted the aarakke/ddev-changelog-example-config branch May 12, 2026 10:31
@dd-octo-sts dd-octo-sts Bot added this to the 7.79.0 milestone May 12, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants