dsccommunity / StorageDsc

DSC resource module is used to manage storage on Windows Servers.
https://dsccommunity.org
MIT License
69 stars 51 forks source link

Clean up Module Manifest - Fixes #191 #193

Closed PlagueHO closed 5 years ago

PlagueHO commented 5 years ago

Pull Request (PR) description

This PR corrects the module manifest to adopt DSC Resource kit standards for Copyright, Author and Company.

Added 'DscResourcesToExport' to manifest to improve information in PowerShell Gallery and removed wildcards from 'FunctionsToExport', 'CmdletsToExport', 'VariablesToExport' and 'AliasesToExport

This Pull Request (PR) fixes the following issues

Task list

@johlju - would you mind reviewing for me when you have a chance - just a simple Manifest cleanup.


This change is Reviewable

codecov-io commented 5 years ago

Codecov Report

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

Impacted file tree graph

@@        Coverage Diff         @@
##           dev   #193   +/-   ##
==================================
  Coverage   94%    94%           
==================================
  Files        8      8           
  Lines      886    886           
==================================
  Hits       834    834           
  Misses      52     52
PlagueHO commented 5 years ago

I've rebased this one now. @johlju - would you mind reviewing when you have a change?

johlju commented 5 years ago

Okay, seems there are no real difference between the two when one is not a collaborator on a repo, it's not possible to "block" without being a collaborator. Hoping this is a thing GitHub resolves eventually. 😄

johlju commented 5 years ago

Adding DscResourcesToExport, I’m curious what it actually improves in the PowerShell Gallery? If I look at SqlServer it do list the resources and that repo does not have the DscResourcesToExport. :thinking: Just want to make sure we don’t add something that makes it harder to maintain when adding new resources. I was looking at adding this to SqlServerDsc as well if it added a better experience in the gallery, but can’t see that it does.

PlagueHO commented 5 years ago

@johlju - you know what: I assumed it did add these to the PS Gallery, but it appears that this happens anyway! So it must be just for Class based resources. The only thing it does is ensure it appears in the ExportedDscResources property of the modules object when scanning all modules: image

But this isn't that important because if you want to find a list of DSC resources on the machine then using Get-DscResources is better.

The main reason for this though is that all the other modules I maintain are set up like this :grin: But happy to remove it if you think it isn't adding anything.

johlju commented 5 years ago

@PlagueHO Please keep it, no need to remove it. But then it is nothing we need to enforce for all modules at least, it can be up to the maintainer. Also, if it is missed when adding a new resource it's not a big deal (it does not break the resource).

johlju commented 5 years ago

@PlagueHO If you resolve the release notes I will LGTM this one. 😄

PlagueHO commented 5 years ago

Ah yes! Good catch @johlju - fixed now.