Skip to content

[Bug] Check mode always returns with zero exit code when embed mode is also enabled #108

@skhoroshavin

Description

@skhoroshavin

Steps to reproduce:

  • update docstrings in some repo, do not regenerate documentation with gomarkdoc
  • run gomarkdoc with both --check and --embed flags enabled

Expected results:

  • gomarkdoc complains in the console about docs not being up to date and returns with non-zero exit code

Actual results:

  • gomarkdoc complains in the console about docs not being up to date, but still returns zero exit code

Impact:

  • this behaviour makes it impossible to create a CI check of whether documentation is up to date, when embed mode is enabled

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions