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

Mkdocs plugin assumes a valid git working tree in all cases #45

Closed
derekm opened this issue Sep 9, 2022 · 2 comments
Closed

Mkdocs plugin assumes a valid git working tree in all cases #45

derekm opened this issue Sep 9, 2022 · 2 comments

Comments

@derekm
Copy link

derekm commented Sep 9, 2022

If Mkdocs plugin is enabled, but source code is used outside of git, for example after git archive, then all gradle tasks will fail as the Mkdocs plugin fails.

Mkdocs plugin should not fail all gradle tasks just because the source code isn't in a git clone.

Mkdocs plugin looks up publish.repoUri, which fails if there is no git metadata or if a config directory exists at the root of the project.

@xvik
Copy link
Owner

xvik commented Sep 11, 2022

Could you please post the error itself here (if possible, run gradle with --stacktrace option). And, please, describe steps to simulate this situatuation (is it multi-module project?).

Plugin works when there is no initialized git in the project (it should be the case for git archive). Anyway, there is only one place that can fail - git origin detection appeared just after project initialization. But I need a guide to reproduce the problem to be sure

There should be a workaround: you can specify mkdocks.publish.repoUrl manually and plugin will not try to auto-detect origin and so should stop failing the build.

@xvik
Copy link
Owner

xvik commented Nov 1, 2022

In the new version 3.0.0 there should be no problem with it.

Moreover, now it is possible to avoid publication tasks (and git related staff) at all with new lightweight plugin version ru.vyarus.mkdocs-build.

Closing this, please reopen if issue will appear again

@xvik xvik closed this as completed Nov 1, 2022
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