chore: linting changelog#2056
Conversation
There was a problem hiding this comment.
Pull request overview
This PR standardizes changelog Markdown formatting across the repo and updates linting/release tooling configs so newly generated changelog entries conform to the enforced Markdown rules.
Changes:
- Reformat many
CHANGELOG.mdfiles to use##release headers and-list markers. - Enable/adjust markdownlint + prettier behavior so changelogs are no longer ignored and unordered lists are enforced as dashes.
- Configure release tooling to generate changelog headers/bullets that satisfy the lint rules.
Reviewed changes
Copilot reviewed 69 out of 70 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| sampler/xray/CHANGELOG.md | Normalize release headers and bullets for lint compliance. |
| resources/google_cloud_platform/CHANGELOG.md | Normalize release headers and bullets for lint compliance. |
| resources/container/CHANGELOG.md | Normalize release headers and bullets for lint compliance. |
| resources/azure/CHANGELOG.md | Normalize release headers and bullets for lint compliance. |
| resources/aws/CHANGELOG.md | Normalize release headers and bullets for lint compliance. |
| propagator/xray/CHANGELOG.md | Normalize release headers and bullets for lint compliance. |
| propagator/vitess/CHANGELOG.md | Normalize release headers and bullets for lint compliance. |
| propagator/ottrace/CHANGELOG.md | Normalize release headers and bullets for lint compliance. |
| propagator/google_cloud_trace_context/CHANGELOG.md | Normalize release headers and bullets for lint compliance. |
| processor/baggage/CHANGELOG.md | Normalize release headers and bullets for lint compliance. |
| instrumentation/trilogy/CHANGELOG.md | Normalize release headers and bullets for lint compliance. |
| instrumentation/ruby_kafka/CHANGELOG.md | Normalize release headers and bullets for lint compliance. |
| instrumentation/rspec/CHANGELOG.md | Normalize release headers and bullets for lint compliance. |
| instrumentation/restclient/CHANGELOG.md | Normalize release headers and bullets for lint compliance. |
| instrumentation/resque/CHANGELOG.md | Normalize release headers and bullets for lint compliance. |
| instrumentation/redis/CHANGELOG.md | Normalize release headers and bullets for lint compliance. |
| instrumentation/rdkafka/CHANGELOG.md | Normalize release headers and bullets for lint compliance. |
| instrumentation/rake/CHANGELOG.md | Normalize release headers and bullets for lint compliance. |
| instrumentation/racecar/CHANGELOG.md | Normalize release headers and bullets for lint compliance. |
| instrumentation/que/CHANGELOG.md | Normalize release headers and bullets for lint compliance. |
| instrumentation/pg/CHANGELOG.md | Normalize release headers and bullets for lint compliance. |
| instrumentation/net_ldap/README.md | Update list markers/spacing to satisfy markdownlint list style. |
| instrumentation/net_ldap/CHANGELOG.md | Normalize release headers and bullets for lint compliance. |
| instrumentation/net_http/CHANGELOG.md | Normalize release headers and bullets for lint compliance. |
| instrumentation/mysql2/CHANGELOG.md | Normalize release headers and bullets for lint compliance. |
| instrumentation/mongo/CHANGELOG.md | Normalize release headers and bullets for lint compliance. |
| instrumentation/logger/CHANGELOG.md | Normalize release headers and bullets for lint compliance. |
| instrumentation/lmdb/CHANGELOG.md | Normalize release headers and bullets for lint compliance. |
| instrumentation/koala/CHANGELOG.md | Normalize release headers and bullets for lint compliance. |
| instrumentation/httpx/CHANGELOG.md | Normalize release headers and bullets for lint compliance. |
| instrumentation/http_client/CHANGELOG.md | Normalize release headers and bullets for lint compliance. |
| instrumentation/http/CHANGELOG.md | Normalize release headers and bullets for lint compliance. |
| instrumentation/gruf/CHANGELOG.md | Normalize release headers and bullets for lint compliance. |
| instrumentation/grpc/CHANGELOG.md | Normalize release headers and bullets for lint compliance. |
| instrumentation/graphql/CHANGELOG.md | Normalize release headers and bullets for lint compliance. |
| instrumentation/grape/CHANGELOG.md | Normalize release headers and bullets for lint compliance. |
| instrumentation/factory_bot/CHANGELOG.md | Normalize release headers and bullets for lint compliance. |
| instrumentation/excon/CHANGELOG.md | Normalize release headers and bullets for lint compliance. |
| instrumentation/delayed_job/CHANGELOG.md | Normalize release headers and bullets for lint compliance. |
| instrumentation/dalli/CHANGELOG.md | Normalize release headers and bullets for lint compliance. |
| instrumentation/concurrent_ruby/CHANGELOG.md | Normalize release headers and bullets for lint compliance. |
| instrumentation/bunny/CHANGELOG.md | Normalize release headers and bullets for lint compliance. |
| instrumentation/base/CHANGELOG.md | Normalize release headers and bullets for lint compliance (also normalizes file formatting). |
| instrumentation/aws_sdk/README.md | Fix indentation (remove tab) for lint consistency. |
| instrumentation/aws_sdk/CHANGELOG.md | Normalize release headers and bullets for lint compliance. |
| instrumentation/aws_lambda/CHANGELOG.md | Normalize release headers and bullets for lint compliance. |
| instrumentation/anthropic/CHANGELOG.md | Normalize release headers and bullets for lint compliance. |
| instrumentation/active_support/CHANGELOG.md | Normalize release headers and bullets for lint compliance. |
| instrumentation/active_storage/CHANGELOG.md | Normalize release headers and bullets for lint compliance. |
| instrumentation/active_record/CHANGELOG.md | Normalize release headers and bullets for lint compliance. |
| instrumentation/active_model_serializers/CHANGELOG.md | Normalize release headers and bullets for lint compliance. |
| instrumentation/active_job/CHANGELOG.md | Normalize release headers and bullets for lint compliance. |
| instrumentation/action_view/CHANGELOG.md | Normalize release headers and bullets for lint compliance. |
| instrumentation/action_pack/CHANGELOG.md | Normalize release headers and bullets for lint compliance. |
| instrumentation/action_mailer/CHANGELOG.md | Normalize release headers and bullets for lint compliance. |
| helpers/sql/CHANGELOG.md | Normalize release headers and bullets for lint compliance. |
| helpers/sql-processor/CHANGELOG.md | Normalize release headers and bullets for lint compliance. |
| helpers/sql-obfuscation/CHANGELOG.md | Normalize release headers and bullets for lint compliance; adjust heading level for nested section. |
| helpers/mysql/CHANGELOG.md | Normalize release headers and bullets for lint compliance. |
| .toys/.data/releases.yml | Configure release tooling to generate compliant changelog headers and dash bullets. |
| .prettierignore | Stop ignoring CHANGELOG.md files so prettier can format them. |
| .markdownlintignore | Stop ignoring CHANGELOG.md files so markdownlint can lint them. |
| .markdownlint.yaml | Enforce - unordered list markers and adjust markdownlint rule settings. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
|
@thompson-tomo Did you manually apply the edits or does toys support fixing the changelogs? @dazuma we could use your input here given config changes to toys. |
|
The symbol was updated using markdownlint/prettier. The header was find and replace as mdlint detected the issue but doesn't have the ability to fix it. See discussion in dazuma/toys#415 as these new options were added as we couldn't lint the changelog. |
This adds in linting of the changelog now that release-toys offers the configuration options required to produce new entries which will pass linting rules.
Note list symbol has been switched to - as historically that was what was originally used and is the required symbol for prettier.
All changes to md have occurred by running the linting tools with fix options and only where necessary targeted find & replace used ie headers.