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

xActiveDirectory: Opt-in to "Common Tests - Validate Example Files To Be Published" #311

Closed
johlju opened this issue Jun 4, 2019 · 0 comments · Fixed by #364
Closed

xActiveDirectory: Opt-in to "Common Tests - Validate Example Files To Be Published" #311

johlju opened this issue Jun 4, 2019 · 0 comments · Fixed by #364
Labels
enhancement The issue is an enhancement request.
Projects
All issues and PR's

Comments

@johlju
Copy link
Member

johlju commented Jun 4, 2019

We should prepare the example to be published. Maybe this should be done once the module is renamed so we don't have examples published for an older module with 'x'.

  • adding the PSScriptInfo block
  • adding the DESCRIPTION in the comment-based help
  • adding the #Requires statement.
  • Rename the examples filename and configuration name to be prefixed with the resource name, and suffixed with _Config.

See example here: https://github.com/PowerShell/xActiveDirectory/blob/dev/Examples/Resources/xADComputer/1-AddComputerAccount_Config.ps1

We could then opt-in for publishing by adding the deploy step:
https://github.com/PowerShell/DscResource.Tests#deploy
@johlju johlju added enhancement The issue is an enhancement request. help wanted The issue is up for grabs for anyone in the community. labels Jun 4, 2019
@johlju johlju added this to To do in All issues and PR's Jun 4, 2019
@X-Guardian X-Guardian mentioned this issue Jun 11, 2019
Merged
9 tasks
All issues and PR's automation moved this from To do to Done Jun 12, 2019
johlju pushed a commit that referenced this issue Jun 12, 2019
@X-Guardian @johlju
xActiveDirectory: OptIn to the "Common Tests - Validate Example Files…
aa801e9 
… To Be Published" (#364)

- Changes to xActiveDirectory
  - Opt-in to the following DSC Resource Common Meta Tests:
    - Common Tests - Validate Example Files To Be Published (issue #311)
@johlju johlju removed the help wanted The issue is up for grabs for anyone in the community. label Jun 12, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement The issue is an enhancement request.
Projects
All issues and PR's
  
Done
Milestone
No milestone
1 participant
@johlju