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

Add examples to PowerShell Gallery #429

Merged
merged 6 commits into from
Jul 3, 2018

Conversation

johlju
Copy link
Member

@johlju johlju commented Jun 21, 2018

  • Changes to xWindowsProcess
    • Increased the wait time in the integration tests since the tests
      still failed randomly (issue #420).
  • Renamed and updated examples to be able to publish them to PowerShell Gallery.
    • Sample_xScript.ps1 → xScript_WatchFileContentConfig.ps1
    • Sample_xService_UpdateStartupTypeIgnoreState.ps1 → xService_UpdateStartupTypeIgnoreStateConfig.ps1

This change is Reviewable

- Increased the wait time in the integration tests since the tests
  still failed randomly (issue dsccommunity#420).
@johlju johlju added the waiting for code fix A review left open comments, and the pull request is waiting for changes to be pushed by the author. label Jun 21, 2018
@johlju
Copy link
Member Author

johlju commented Jun 21, 2018

This will not work until

  1. The PR Add support for publishing examples configurations to PowerShell Gallery PowerShell/DscResource.Tests#235 is merged,
  2. The correct encrypted API key is added to the appveyor.yml.

@codecov-io
Copy link

codecov-io commented Jun 21, 2018

Codecov Report

Merging #429 into dev will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@         Coverage Diff         @@
##            dev   #429   +/-   ##
===================================
  Coverage    73%    73%           
===================================
  Files        27     27           
  Lines      3995   3995           
  Branches      4      4           
===================================
  Hits       2921   2921           
  Misses     1070   1070           
  Partials      4      4

@johlju johlju added on hold The issue or pull request has been put on hold by a maintainer. and removed waiting for code fix A review left open comments, and the pull request is waiting for changes to be pushed by the author. labels Jun 28, 2018
@johlju
Copy link
Member Author

johlju commented Jun 28, 2018

Reviewed 6 of 6 files at r1.
Review status: all files reviewed, 7 unresolved discussions


appveyor.yml, line 1 at r1 (raw file):

#---------------------------------#

The DscResource.Template should be updated with this.


appveyor.yml, line 8 at r1 (raw file):

environment:
  gallery_api:
    secure: uwd5h4xufRG6/4wEOUIrdEeTkXYIiLFydKXhP5ZKv5j8rR2acKOHrsL7c2UoYmZQ

Should have the correct API key


README.md, line 668 at r1 (raw file):

    still failed randomly ([issue #420](https://github.com/PowerShell/xPSDesiredStateConfiguration/issues/420)).
* Renamed and updated examples to be able to publish them to PowerShell Gallery.
  * Sample_xScript.ps1 → xScript_WatchFileContentConfig.ps1

We should escape underscore in markdown.


Examples/xService_UpdateStartupTypeIgnoreStateConfig.ps1, line 1 at r1 (raw file):

Remove blank row.


Examples/xScript_WatchFileContentConfig.ps1, line 1 at r1 (raw file):

Remove blank row.


Examples/xScript_WatchFileContentConfig.ps1, line 31 at r1 (raw file):

Defaults to $env:TEMP.

No longer true.


Examples/xScript_WatchFileContentConfig.ps1, line 35 at r1 (raw file):

Defaults to 'Just some sample text to write to the file'.

No longer true.


Comments from Reviewable

@johlju
Copy link
Member Author

johlju commented Jun 28, 2018

Review status: all files reviewed, 12 unresolved discussions


Examples/xService_UpdateStartupTypeIgnoreStateConfig.ps1, line 22 at r1 (raw file):

<#
    .DESCRIPTION

We should have .SYNOPSIS to so Get-Help looks pretty (that defaults to .SYNOPSIS)?


Examples/xService_UpdateStartupTypeIgnoreStateConfig.ps1, line 23 at r1 (raw file):

Updates startup

'Configuration that updates startup...'


Examples/xService_UpdateStartupTypeIgnoreStateConfig.ps1, line 26 at r1 (raw file):

        it's current state (e.g. running, stopped, etc).

    .NOTES

Add an .EXAMPLE too?


Examples/xScript_WatchFileContentConfig.ps1, line 23 at r1 (raw file):

Creates a file 

'Configuration that creates a file...'


Examples/xScript_WatchFileContentConfig.ps1, line 33 at r1 (raw file):

        The path at which to create the file. Defaults to $env:TEMP.

    .PARAMETER FileContent

Add an .EXAMPLE too?


Comments from Reviewable

@johlju
Copy link
Member Author

johlju commented Jun 29, 2018

Review status: all files reviewed, 13 unresolved discussions


README.md, line 441 at r1 (raw file):

#### Examples

* [Create a file with content through xScript](https://github.com/PowerShell/xPSDesiredStateConfiguration/blob/dev/Examples/Sample_xScript.ps1)

Examples need to be updated here


Comments from Reviewable

@johlju
Copy link
Member Author

johlju commented Jul 2, 2018

Review status: 5 of 7 files reviewed, 11 unresolved discussions (waiting on @johlju)


appveyor.yml, line 1 at r1 (raw file):

Previously, johlju (Johan Ljunggren) wrote…

The DscResource.Template should be updated with this.

Done. Proposed in PR PowerShell/DscResources#411.


Comments from Reviewable

@johlju
Copy link
Member Author

johlju commented Jul 3, 2018

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


README.md, line 441 at r1 (raw file):

Previously, johlju (Johan Ljunggren) wrote…

Examples need to be updated here

Done.


README.md, line 668 at r1 (raw file):

Previously, johlju (Johan Ljunggren) wrote…

We should escape underscore in markdown.

Done.


Examples/xService_UpdateStartupTypeIgnoreStateConfig.ps1, line 1 at r1 (raw file):

Previously, johlju (Johan Ljunggren) wrote…

Remove blank row.

Done


Examples/xService_UpdateStartupTypeIgnoreStateConfig.ps1, line 22 at r1 (raw file):

Previously, johlju (Johan Ljunggren) wrote…

We should have .SYNOPSIS to so Get-Help looks pretty (that defaults to .SYNOPSIS)?

Done


Examples/xService_UpdateStartupTypeIgnoreStateConfig.ps1, line 23 at r1 (raw file):

Previously, johlju (Johan Ljunggren) wrote…
Updates startup

'Configuration that updates startup...'

Done


Examples/xService_UpdateStartupTypeIgnoreStateConfig.ps1, line 26 at r1 (raw file):

Previously, johlju (Johan Ljunggren) wrote…

Add an .EXAMPLE too?

Done


Examples/xScript_WatchFileContentConfig.ps1, line 1 at r1 (raw file):

Previously, johlju (Johan Ljunggren) wrote…

Remove blank row.

Done


Examples/xScript_WatchFileContentConfig.ps1, line 23 at r1 (raw file):

Previously, johlju (Johan Ljunggren) wrote…
Creates a file 

'Configuration that creates a file...'

Done


Examples/xScript_WatchFileContentConfig.ps1, line 31 at r1 (raw file):

Previously, johlju (Johan Ljunggren) wrote…
Defaults to $env:TEMP.

No longer true.

Done


Examples/xScript_WatchFileContentConfig.ps1, line 33 at r1 (raw file):

Previously, johlju (Johan Ljunggren) wrote…

Add an .EXAMPLE too?

Done


Examples/xScript_WatchFileContentConfig.ps1, line 35 at r1 (raw file):

Previously, johlju (Johan Ljunggren) wrote…
Defaults to 'Just some sample text to write to the file'.

No longer true.

Done


Comments from Reviewable

@johlju johlju added needs review The pull request needs a code review. and removed on hold The issue or pull request has been put on hold by a maintainer. labels Jul 3, 2018
@johlju
Copy link
Member Author

johlju commented Jul 3, 2018

Closing and reopening to run this against newly update DscResource.Tests

@johlju johlju closed this Jul 3, 2018
@johlju johlju removed the needs review The pull request needs a code review. label Jul 3, 2018
@johlju johlju reopened this Jul 3, 2018
@johlju johlju changed the title WIP: Add examples to PowerShell Gallery Add examples to PowerShell Gallery Jul 3, 2018
@johlju johlju added the needs review The pull request needs a code review. label Jul 3, 2018
@johlju
Copy link
Member Author

johlju commented Jul 3, 2018

:LGTM:


Review status: :shipit: complete! all files reviewed, all discussions resolved


Comments from Reviewable

@johlju johlju merged commit 5535f51 into dsccommunity:dev Jul 3, 2018
@johlju johlju removed the needs review The pull request needs a code review. label Jul 3, 2018
@johlju johlju deleted the add-gallery-examples branch July 3, 2018 15:21
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.

2 participants