FFFF [Bug] Check mode always returns with zero exit code when embed mode is also enabled · Issue #108 · princjef/gomarkdoc · GitHub
[go: up one dir, main page]

Skip to content

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

Open

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

Activity

  1. princjef commented on Aug 19, 2023

    @princjef
    Owner

    Hi @skhoroshavin, I just added a test for the scenario you described and am unable to reproduce the behavior you're seeing. Which version of the tool are you using? I know there were some issues in the past with the check mode not properly checking things but I'm not aware of any current issues.

    If you're still seeing the issue with the latest version (1.1.0), it might help if you can provide a sample test case as well as which OS you're using to help track down the issue

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

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

      0