chore: linting changelog (#2056)

* Standardize on - for lists

* Fix changelog headers

* review feedback

Author: thompson-tomo

.markdownlint.yaml

@@ -10,3 +10,4 @@ line-length:
   line_length: 500
 no-inline-html: false
 custom-rules-below-this-point: false
+no-bare-urls: false

.markdownlintignore

@@ -1,2 +1 @@
-**/CHANGELOG.md
 node_modules

.prettierignore

@@ -1,3 +1,2 @@
-**/CHANGELOG.md
 **/README.md
 **/sql_obfuscation.json

.toys/.data/releases.yml

@@ -14,6 +14,11 @@ update_existing_requests: true
 git_user_name: otelbot
 git_user_email: 197425009+otelbot@users.noreply.github.com
 
+# Sets the list symbol used for bullet points in the generated changelog to be "-" which complies with markdownlint and prettier. Note The default is "*".
+changelog_bullet: "-"
+
+changelog_release_header_format: "## v%v / %Y-%m-%d"
+
 # List of all releasable gems. Each gem should include:
 #  *  name: The name of the gem. (Required.)
 #  *  directory: Gem directory relative to the repo root.

helpers/mysql/CHANGELOG.md

@@ -1,31 +1,31 @@
 # Release History: opentelemetry-helpers-mysql
 
-### v0.5.0 / 2026-03-17
+## v0.5.0 / 2026-03-17
 
-* ADDED: Optimize extract_statement_type regex and encoding in helpers-mysql (#2088)
+- ADDED: Optimize extract_statement_type regex and encoding in helpers-mysql (#2088)
 
-### v0.4.0 / 2025-10-22
+## v0.4.0 / 2025-10-22
 
-* BREAKING CHANGE: Min Ruby Version 3.2
-* ADDED: Min Ruby Version 3.2
+- BREAKING CHANGE: Min Ruby Version 3.2
+- ADDED: Min Ruby Version 3.2
 
-### v0.3.0 / 2025-09-30
+## v0.3.0 / 2025-09-30
 
-* ADDED: Bump minimum API Version to 1.7
+- ADDED: Bump minimum API Version to 1.7
 
-### v0.2.0 / 2025-01-16
+## v0.2.0 / 2025-01-16
 
-* BREAKING CHANGE: Set minimum supported version to Ruby 3.1
-* ADDED: Set minimum supported version to Ruby 3.1
+- BREAKING CHANGE: Set minimum supported version to Ruby 3.1
+- ADDED: Set minimum supported version to Ruby 3.1
 
-### v0.1.2 / 2024-11-26
+## v0.1.2 / 2024-11-26
 
-* (No significant changes)
+- (No significant changes)
 
-### v0.1.1 / 2024-06-18
+## v0.1.1 / 2024-06-18
 
-* FIXED: Relax otel common gem constraints
+- FIXED: Relax otel common gem constraints
 
-### v0.1.0 / 2024-02-08
+## v0.1.0 / 2024-02-08
 
-Initial release.
+- Initial release.

helpers/sql-obfuscation/CHANGELOG.md

@@ -1,35 +1,35 @@
 # Release History: opentelemetry-helpers-sql-obfuscation
 
-### v0.5.0 / 2025-10-22
+## v0.5.0 / 2025-10-22
 
-* BREAKING CHANGE: Min Ruby Version 3.2
-* ADDED: Min Ruby Version 3.2
+- BREAKING CHANGE: Min Ruby Version 3.2
+- ADDED: Min Ruby Version 3.2
 
-### v0.4.0 / 2025-10-08
+## v0.4.0 / 2025-10-08
 
-#### Deprecation Notice
+### Deprecation Notice
 
-* **DEPRECATED:** This gem, `opentelemetry-helpers-sql-obfuscation`, has been replaced by `opentelemetry-helpers-sql-processor`. This is the final release and serves as a transitional package.
-* **ACTION REQUIRED:** No action is needed unless you use this gem directly. If you use this gem directly, update your `Gemfile` to use `gem 'opentelemetry-helpers-sql-processor'` instead.
-* **SUPPORT ENDING:** `opentelemetry-helpers-sql-obfuscation` will no longer receive updates.
+- **DEPRECATED:** This gem, `opentelemetry-helpers-sql-obfuscation`, has been replaced by `opentelemetry-helpers-sql-processor`. This is the final release and serves as a transitional package.
+- **ACTION REQUIRED:** No action is needed unless you use this gem directly. If you use this gem directly, update your `Gemfile` to use `gem 'opentelemetry-helpers-sql-processor'` instead.
+- **SUPPORT ENDING:** `opentelemetry-helpers-sql-obfuscation` will no longer receive updates.
 
-### v0.3.0 / 2025-01-16
+## v0.3.0 / 2025-01-16
 
-* BREAKING CHANGE: Set minimum supported version to Ruby 3.1
-* ADDED: Set minimum supported version to Ruby 3.1
+- BREAKING CHANGE: Set minimum supported version to Ruby 3.1
+- ADDED: Set minimum supported version to Ruby 3.1
 
-### v0.2.1 / 2024-11-26
+## v0.2.1 / 2024-11-26
 
-* (No significant changes)
+- (No significant changes)
 
-### v0.2.0 / 2024-09-12
+## v0.2.0 / 2024-09-12
 
 - BREAKING CHANGE: Return message when sql is over the obfuscation limit. Fixes a bug where sql statements with prepended comments that hit the obfuscation limit would be sent raw.
 
-### v0.1.1 / 2024-06-18
+## v0.1.1 / 2024-06-18
 
 - FIXED: Relax otel common gem constraints
 
-### v0.1.0 / 2024-02-08
+## v0.1.0 / 2024-02-08
 
-Initial release.
+- Initial release.

helpers/sql-processor/CHANGELOG.md

@@ -1,22 +1,22 @@
 # Release History: opentelemetry-helpers-sql-processor
 
-### v0.4.0 / 2026-01-13
+## v0.4.0 / 2026-01-13
 
-* ADDED: Add SQL Comment Propagator
+- ADDED: Add SQL Comment Propagator
 
-### v0.3.1 / 2025-11-11
+## v0.3.1 / 2025-11-11
 
-* DOCS: Update example to match new gem namespace (sql-processor)
+- DOCS: Update example to match new gem namespace (sql-processor)
 
-### v0.3.0 / 2025-11-04
+## v0.3.0 / 2025-11-04
 
-* ADDED: Refactor SQL processor file structure for clarity
+- ADDED: Refactor SQL processor file structure for clarity
 
-### v0.2.0 / 2025-10-22
+## v0.2.0 / 2025-10-22
 
-* BREAKING CHANGE: Min Ruby Version 3.2
-* ADDED: Min Ruby Version 3.2
+- BREAKING CHANGE: Min Ruby Version 3.2
+- ADDED: Min Ruby Version 3.2
 
-### v0.1.0 / 2025-10-08
+## v0.1.0 / 2025-10-08
 
-Initial release.
+- Initial release.

helpers/sql/CHANGELOG.md

@@ -1,18 +1,18 @@
 # Release History: opentelemetry-helpers-sql
 
-### v0.3.0 / 2025-10-22
+## v0.3.0 / 2025-10-22
 
-* BREAKING CHANGE: Min Ruby Version 3.2
-* ADDED: Min Ruby Version 3.2
+- BREAKING CHANGE: Min Ruby Version 3.2
+- ADDED: Min Ruby Version 3.2
 
-### v0.2.0 / 2025-09-30
+## v0.2.0 / 2025-09-30
 
-* ADDED: Bump minimum API Version to 1.7
+- ADDED: Bump minimum API Version to 1.7
 
-### v0.1.1 / 2025-04-14
+## v0.1.1 / 2025-04-14
 
-* (No significant changes)
+- (No significant changes)
 
-### v0.1.0 / 2025-01-24
+## v0.1.0 / 2025-01-24
 
-Initial release.
+- Initial release.

instrumentation/action_mailer/CHANGELOG.md

@@ -1,33 +1,33 @@
 # Release History: opentelemetry-instrumentation-action_mailer
 
-### v0.6.1 / 2025-10-22
+## v0.6.1 / 2025-10-22
 
-* FIXED: Update opentelemetry-instrumentation-base dependency
+- FIXED: Update opentelemetry-instrumentation-base dependency
 
-### v0.6.0 / 2025-10-21
+## v0.6.0 / 2025-10-21
 
-* BREAKING CHANGE: Min Ruby Version 3.2 and Rails 7.1
-* ADDED: Min Ruby Version 3.2 and Rails 7.1
+- BREAKING CHANGE: Min Ruby Version 3.2 and Rails 7.1
+- ADDED: Min Ruby Version 3.2 and Rails 7.1
 
-### v0.5.0 / 2025-09-30
+## v0.5.0 / 2025-09-30
 
-* ADDED: Bump minimum API Version to 1.7
+- ADDED: Bump minimum API Version to 1.7
 
-### v0.4.0 / 2025-01-16
+## v0.4.0 / 2025-01-16
 
-* BREAKING CHANGE: Drop Support for EoL Rails 6.1
-* BREAKING CHANGE: Set minimum supported version to Ruby 3.1
-* ADDED: Drop Support for EoL Rails 6.1
-* ADDED: Set minimum supported version to Ruby 3.1
+- BREAKING CHANGE: Drop Support for EoL Rails 6.1
+- BREAKING CHANGE: Set minimum supported version to Ruby 3.1
+- ADDED: Drop Support for EoL Rails 6.1
+- ADDED: Set minimum supported version to Ruby 3.1
 
-### v0.3.0 / 2024-12-19
+## v0.3.0 / 2024-12-19
 
-* ADDED: Upgrade ActiveSupport Instrumentation 0.7.0
+- ADDED: Upgrade ActiveSupport Instrumentation 0.7.0
 
-### v0.2.0 / 2024-10-22
+## v0.2.0 / 2024-10-22
 
-* ADDED: Subscribe to process.action_mailer notifications
+- ADDED: Subscribe to process.action_mailer notifications
 
-### v0.1.0 / 2024-05-13
+## v0.1.0 / 2024-05-13
 
-Initial release.
+- Initial release.