Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add markdown support to banner message #21688

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Ankurk99
Copy link

@Ankurk99 Ankurk99 commented Mar 3, 2025

Summary

Harbor provides a global configuration for setting a banner message, which is useful for displaying important notices to users, especially for maintenance.
One of our use-cases requires adding links to these messages to direct our users to more information. However, since BannerMessage is an HTML-safe string, it does not support HTML tags, making it difficult to include links.

This PR adds support for markdown in the banner message.

Issue being fixed

Fixes #21657

Please indicate you've done the following:

  • Well Written Title and Summary of the PR
  • Label the PR as needed. "release-note/ignore-for-release, release-note/new-feature, release-note/update, release-note/enhancement, release-note/community, release-note/breaking-change, release-note/docs, release-note/infra, release-note/deprecation"
  • Accepted the DCO. Commits without the DCO will delay acceptance.
  • Made sure tests are passing and test coverage is added if needed.
  • Considered the docs impact and opened a new docs issue or PR with docs changes if needed in website repository.

@Ankurk99 Ankurk99 requested a review from a team as a code owner March 3, 2025 18:01
@Ankurk99
Copy link
Author

Ankurk99 commented Mar 3, 2025

Please let me know if any updates are needed for test coverage or documentation.

Copy link
Contributor

@xuelichao xuelichao left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@xuelichao xuelichao left a comment

Choose a reason for hiding this comment

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

Please fix the pipeline error

@Ankurk99 Ankurk99 force-pushed the add-md-to-banner-message branch from 40e9df4 to bd42cb4 Compare March 6, 2025 15:09
@Ankurk99 Ankurk99 requested a review from xuelichao March 7, 2025 08:48
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.

support links in banner message
5 participants