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

Handles dashes in documentation in repository Wiki #159

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

johlju
Copy link
Member

@johlju johlju commented Oct 14, 2024

Pull Request (PR) description

Removed

  • Removed build.psd1 as it is no longer required to build the project.

Added

  • Added private function ConvertTo-WikiSidebarLinkName that converts a
    name to a format suitable for use as a Wiki sidebar link.
  • New tasks:
    • Prepare_Markdown_FileNames_For_GitHub_Publish - This task will prepare
      the markdown file names for publishing to the GitHub Wiki by replacing
      hyphens with spaces and converting Unicode hyphens to standard hyphens.
      It can be controlled by parameter ReplaceHyphen in the task, which
      defaults to $true.
    • Clean_WikiContent_For_GitHub_Publish - This task will remove the top
      level header from any markdown file where the top level header equals the
      filename (converting Unicode hyphen to ASCII hyphen before comparison).
      It can be controlled by parameter RemoveTopLevelHeader in the task, which
      defaults to $true.

Changed

  • New-GitHubWikiSidebar
    • Replaces ASCII hyphens for the Wiki sidebar.
    • Replaces Unicode hyphens with standard hyphens for the Wiki sidebar.
  • Task Generate_Wiki_Content
    • Now calls Prepare_Markdown_FileNames_For_GitHub_Publish after the
      markdown files and external help file for command help has been generated.
    • Now calls Clean_WikiContent_For_GitHub_Publish as the last step to
      remove the top level header from any markdown file where the top level
      header equals the filename.
  • Task Generate_Markdown_For_Public_Commands
    • Verbose output of the markdown files that was created.

This Pull Request (PR) fixes the following issues

Task list

  • Added an entry to the change log under the Unreleased section of the file CHANGELOG.md.
    Entry should say what was changed and how that affects users (if applicable), and
    reference the issue being resolved (if applicable).
  • Documentation added/updated in README.md.
  • Comment-based help added/updated.
  • Localization strings added/updated in all localization files as appropriate.
  • Examples appropriately added/updated.
  • Unit tests added/updated. See DSC Community Testing Guidelines.
  • Integration tests added/updated (where possible). See DSC Community Testing Guidelines.
  • New/changed code adheres to DSC Community Style Guidelines.

This change is Reviewable

Copy link

codecov bot commented Oct 14, 2024

Codecov Report

Attention: Patch coverage is 8.33333% with 55 lines in your changes missing coverage. Please review.

Project coverage is 91%. Comparing base (8dad542) to head (24c3d5d).
Report is 3 commits behind head on main.

Files with missing lines Patch % Lines
...sks/Clean_WikiContent_For_GitHub_Publish.build.ps1 0% 29 Missing ⚠️
...re_Markdown_FileNames_For_GitHub_Publish.build.ps1 0% 25 Missing ⚠️
source/tasks/Generate_Wiki_Content.build.ps1 0% 1 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@         Coverage Diff         @@
##           main   #159   +/-   ##
===================================
- Coverage    95%    91%   -4%     
===================================
  Files        65     15   -50     
  Lines      1251   1313   +62     
===================================
+ Hits       1189   1197    +8     
- Misses       62    116   +54     
Files with missing lines Coverage Δ
...ks/Generate_Markdown_For_Public_Commands.build.ps1 84% <100%> (+1%) ⬆️
source/tasks/Generate_Wiki_Content.build.ps1 0% <0%> (ø)
...re_Markdown_FileNames_For_GitHub_Publish.build.ps1 0% <0%> (ø)
...sks/Clean_WikiContent_For_GitHub_Publish.build.ps1 0% <0%> (ø)

... and 54 files with indirect coverage changes

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.

Correctly handle dashes in commands and general documentation in repository Wiki
1 participant