Skip to content

[CI] Improve changelog link check TIP message to mention issue links - #19379

Merged
mrodm merged 1 commit into
elastic:mainfrom
mrodm:update_changelog_link_message
Jun 4, 2026
Merged

mrodm merged 1 commit into
elastic:mainfrom
mrodm:update_changelog_link_message

Conversation

@mrodm

@mrodm mrodm commented Jun 4, 2026 •

Copy link
Copy Markdown
Collaborator

Proposed commit message

[CI] Improve changelog link check TIP message to mention issue links

When the changelog link check fails, the TIP callout now informs
developers that using an issue link is also a valid alternative to
adding the skip label.

WHAT:

Update the error TIP callout in .buildkite/scripts/check_changelog_entries.sh to mention that an issue link (.../issues/<n>) can be used in the link: field as an alternative to the current PR link — the check already accepts issue links without validation.

WHY:

The original TIP only mentioned the changelog-link-check:skip label, leaving developers unaware that they can simply use an issue link if that is their intent. This small addition makes the error message more actionable and self-contained.

Author's Checklist

  • No script or test changes required — message-only update.

Related issues


This PR was generated with the assistance of Claude (claude-sonnet-4-6).

@mrodm mrodm self-assigned this Jun 4, 2026
@mrodm
mrodm force-pushed the update_changelog_link_message branch from 111cbd7 to 31f77a8 Compare June 4, 2026 10:57
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@mrodm
mrodm force-pushed the update_changelog_link_message branch from 31f77a8 to d5380f9 Compare June 4, 2026 11:02
message+="- \`${f}\`"$'\n'
done
message+=$'\n'"> [!TIP]"$'\n'"> Add the \`${CHANGELOG_SKIP_LABEL}\` label to skip this check."
message+=$'\n'"> [!TIP]"$'\n'"> If expected, add the \`${CHANGELOG_SKIP_LABEL}\` label to skip this check. Or, if an issue link was intended, use \`.../issues/<n>\` instead."

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be rendered as:

Tip

If expected, add the changelog-link-check:skip label to skip this check. Or, if an issue link was intended, use.../issues/<n> instead.

@elasticmachine

Copy link
Copy Markdown

💚 Build Succeeded

History

cc @mrodm

@mrodm
mrodm marked this pull request as ready for review June 4, 2026 11:11
@mrodm
mrodm requested a review from a team as a code owner June 4, 2026 11:11
@mrodm
mrodm merged commit 836f285 into elastic:main Jun 4, 2026
9 checks passed
@mrodm
mrodm deleted the update_changelog_link_message branch June 4, 2026 11:15
@mrodm mrodm mentioned this pull request Jun 4, 2026
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants