Skip to content

Commit 6d5ea54

Browse files
Fix changelog format for Markdown linter (#16188)
1 parent d80b3ed commit 6d5ea54

File tree

2 files changed

+4
-5
lines changed

2 files changed

+4
-5
lines changed

scripts/github-changelog.cr

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -338,7 +338,7 @@ class ChangelogEntry
338338

339339
def to_s(io : IO)
340340
if sub_topic = pr.sub_topic
341-
io << "*(" << sub_topic << ")* "
341+
io << "_(" << sub_topic << ")_ "
342342
end
343343
if pr.labels.includes?("security")
344344
io << "**[security]** "
@@ -454,8 +454,7 @@ TOPIC_ORDER = %w[lang stdlib compiler tools other]
454454
puts "## [#{milestone.title}] (#{milestone.release_date.try(&.to_s("%F")) || "unreleased"})"
455455
if description = milestone.description.presence
456456
puts
457-
print "_", description
458-
puts "_"
457+
puts description
459458
end
460459
puts
461460
puts "[#{milestone.title}]: https://github.com/#{repository}/releases/#{milestone.title}"

scripts/release-update.sh

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,9 @@ rm -f src/SOURCE_DATE_EPOCH
2525
# Truncate CHANGELOG.md
2626
sed -i -E '/^## \[/,/^## Previous Releases/{/^## Previous Releases/!d}' CHANGELOG.md
2727

28-
if ! grep -q https://github.com/crystal-lang/crystal/blob/release/${CRYSTAL_VERSION%.*}/CHANGELOG.md CHANGELOG.md; then
28+
if ! grep -q "https://github.com/crystal-lang/crystal/blob/release/${CRYSTAL_VERSION%.*}/CHANGELOG.md" CHANGELOG.md; then
2929
sed -i -E "/For information on prior releases/{ N;a\
30-
* [${CRYSTAL_VERSION%.*}](https://github.com/crystal-lang/crystal/blob/release/${CRYSTAL_VERSION%.*}/CHANGELOG.md)
30+
- [${CRYSTAL_VERSION%.*}](https://github.com/crystal-lang/crystal/blob/release/${CRYSTAL_VERSION%.*}/CHANGELOG.md)
3131
}" CHANGELOG.md
3232
fi
3333

0 commit comments

Comments
 (0)