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

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

Open
skhoroshavin opened this issue Jul 25, 2023 · 1 comment

Comments

@skhoroshavin
Copy link

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
@princjef
Copy link
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
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants