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.

Sign up for GitHub

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

Jump to bottom

Conceptual help cannot be generated if the README.md is using upper-case #42

Closed
johlju opened this issue Jul 28, 2020 · 1 comment · Fixed by #43
Closed

Conceptual help cannot be generated if the README.md is using upper-case #42

johlju opened this issue Jul 28, 2020 · 1 comment · Fixed by #43
Labels
bug The issue is a bug.

Comments

@johlju
Copy link
Member

johlju commented Jul 28, 2020

When the conceptual help is generated on Linux the filenames are case sensitive so if a repository is using the word README in upper-case the conceptual help will not be generated.

DscResource.DocGenerator/source/Public/New-DscResourcePowerShellHelp.ps1

Line 100 in 5d43665

$descriptionPath = Join-Path -Path $mofSchema.DirectoryName -ChildPath 'readme.md'

@johlju johlju added bug The issue is a bug. help wanted The issue is up for grabs for anyone in the community. labels Jul 28, 2020
@gaelcolas
Copy link
Member

If you use Get-Item instead I think it's case insensitive.
Get-Item -Path ... -EA SilentlyContinue

@johlju johlju added in progress The issue is being actively worked on by someone. and removed help wanted The issue is up for grabs for anyone in the community. labels Aug 1, 2020
@johlju johlju mentioned this issue Aug 1, 2020
Merged
8 tasks
@johlju johlju removed the in progress The issue is being actively worked on by someone. label Jul 16, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug The issue is a bug.
Projects
None yet
Milestone
No milestone
2 participants
@johlju @gaelcolas