Skip to content

Readme Plugin: Hide comments when rendering the README in Backstage #234

@renatafaracobah

Description

@renatafaracobah

Please do not disclose security vulnerabilities as issues. See our security policy for responsible disclosures.

Describe the bug

When I add a comment to the read me file, they are not rendered by Github but they are shown in the Readme card on backstage.
Example:

<!-- This is a comment and should not be rendered -->

To reproduce

Steps to reproduce the behavior:

  1. Set up your readme.md file to have markdown comments
  2. Add the component pointing to your repository/read-me
  3. Check the Readme card

Screenshots

readme-card

Environment

  • Axis device model: [e.g. Q1615 Mk III]
  • Axis device firmware version: [e.g. 10.5]
  • Stack trace or logs: [e.g. Axis device system logs]
  • OS and version: [e.g. macOS v12.2.1, Ubuntu 20.04 LTS, Windows build 21996.1]
  • Version: [version of the application, SDK, runtime environment, package manager, interpreter, compiler, depending on what seems relevant]

Additional context

Using packages:
@axis-backstage/plugin-readme@^0.9.0
@axis-backstage/plugin-readme-backend@^0.8.0

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions