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

Filter non-directory and hidden files from version directories #3973

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

jeffdgr8
Copy link

Fixes #3963

Copy link
Collaborator

@whyoleg whyoleg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!
Could you please check the comment?

@@ -23,7 +23,9 @@ public data class VersioningConfiguration(
if (olderVersionsDir != null)
assert(olderVersionsDir!!.isDirectory) { "Supplied previous version $olderVersionsDir is not a directory!" }

return olderVersionsDir?.listFiles()?.toList().orEmpty() + olderVersions.orEmpty()
return olderVersionsDir?.listFiles()
?.filter { it.isDirectory && !it.isHidden }
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we really need to filter out hidden directories here? Their definition is a bit vague, and I think that getting just directories should be enough.

If you think, that we should still filter out hidden directories for some reason, then it would be nice to add a comment for reasoning there.

Copy link
Author

@jeffdgr8 jeffdgr8 Jan 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My reasoning was that typically a hidden directory wouldn't be used to store a versioned docs archive, but could be some system created or metadata directory. While .DS_Store was the cause of the issue I ran into and would be filtered out by just ignoring non-directory files, I was thinking there could be other hidden system or metadata files that are directories. An example might be .git or less likely .idea.

If you think it's more likely valid version directories actually are hidden, we could remove the !it.isHidden check. I'm fine either way.

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

Successfully merging this pull request may close these issues.

Versioning plugin + Dokka v2 Gradle plugin false .DS_Store warning
2 participants