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

AzureDevOpsDsc: Support publish wiki documentation #31

Merged
merged 6 commits into from
Feb 11, 2021

Conversation

johlju
Copy link
Member

@johlju johlju commented Feb 8, 2021

Pull Request (PR) description

  • AzureDevOpsDsc
    • Added pipeline support for publish markdown content to the GitHub repository
      wiki (issue #15).
      This will publish the markdown documentation that is generated bu the
      build pipeline.
    • Added new source folder WikiSource. Every markdown file in the folder
      WikiSource will be published to the GitHub repository wiki. The markdown
      file Home.md will be updated with the correct module version on each
      publish to gallery (including preview).
    • Updated pipeline file RequiredModules.ps1 to latest pipeline pattern.
    • Updated pipeline file build.yaml to latest pipeline pattern.
  • AzDevOpsProject
    • Added description to the comment-based help.
    • Added a validate set to the parameter SourceControlType to (for now)
      limit the parameter to the values Git and Tfvc.
    • Update comment-based help to remove text which the valid values are
      since that is now add automatically to the documentation (conceptual
      help and wiki documentation).

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).
  • Resource documentation updated in the resource's README.md.
  • Resource parameter descriptions updated in schema.mof.
  • Comment-based help updated, including parameter descriptions.
  • Localization strings updated.
  • Examples updated.
  • Unit tests updated. See DSC Community Testing Guidelines.
  • Integration tests updated (where possible). See DSC Community Testing Guidelines.
  • Code changes adheres to DSC Community Style Guidelines.

This change is Reviewable

@johlju
Copy link
Member Author

johlju commented Feb 9, 2021

@SphenicPaul small one to enable Wiki publish and also limit the property SourceControlType to the two valid values (the values will show up automatically in the conceptual help and wiki doc).

@johlju johlju added the needs review The pull request needs a code review. label Feb 9, 2021
@johlju
Copy link
Member Author

johlju commented Feb 9, 2021

Integration tests cannot run until merged to main.

Copy link
Contributor

@SphenicPaul SphenicPaul left a comment

Choose a reason for hiding this comment

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

@johlju - Sorry for the delay in reviewing this - I've just the 1 comment relating to a grammatical error that looks to have existed before this change but might as well be fixed as part of this.

Reviewed 6 of 6 files at r1.
Reviewable status: all files reviewed, 1 unresolved discussion (waiting on @johlju)


source/Classes/010.AzDevOpsProject.ps1, line 21 at r1 (raw file):

changed

This should probably be corrected to change (i.e. remove the d).

Copy link
Member Author

@johlju johlju left a comment

Choose a reason for hiding this comment

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

No worries. 🙂 We are all busy with day jobs. 🙂

Reviewable status: 5 of 6 files reviewed, 1 unresolved discussion (waiting on @SphenicPaul)


source/Classes/010.AzDevOpsProject.ps1, line 21 at r1 (raw file):

Previously, SphenicPaul (Paul J. Wilcox) wrote…
changed

This should probably be corrected to change (i.e. remove the d).

Done.

Copy link
Contributor

@SphenicPaul SphenicPaul left a comment

Choose a reason for hiding this comment

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

:lgtm:

Reviewed 1 of 1 files at r2.
Reviewable status: :shipit: complete! all files reviewed, all discussions resolved

@johlju johlju merged commit 5cd23a0 into dsccommunity:main Feb 11, 2021
@johlju johlju deleted the f/support-publish-wiki branch February 11, 2021 19:09
@johlju johlju removed the needs review The pull request needs a code review. label Feb 11, 2021
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.

AzureDevOpsDsc: Wiki help and examples needs automatically generating
2 participants