Merge pull request #45 from PowerShell/dev

Release of version 1.3.0.0 of xBitlocker

.MetaTestOptIn.json

@@ -0,0 +1,13 @@
+[
+    "Common Tests - Validate Markdown Files",
+    "Common Tests - Validate Module Files",
+    "Common Tests - Validate Script Files",
+    "Common Tests - Validate Example Files",
+    "Common Tests - Validate Example Files To Be Published",
+    "Common Tests - Required Script Analyzer Rules",
+    "Common Tests - New Error-Level Script Analyzer Rules",
+    "Common Tests - Custom Script Analyzer Rules",
+    "Common Tests - Flagged Script Analyzer Rules",
+    "Common Tests - Relative Path Length",
+    "Common Tests - Validate Markdown Links"
+]

.gitattributes

@@ -0,0 +1,2 @@
+# Needed for publishing of examples, build worker defaults to core.autocrlf=input.
+* text eol=crlf

.github/ISSUE_TEMPLATE/General.md

@@ -0,0 +1,7 @@
+---
+name: General question or documentation update
+about: If you have a general question or documentation update suggestion around the resource module.
+---
+<!--
+    Your feedback and support is greatly appreciated, thanks for contributing!
+-->

.github/ISSUE_TEMPLATE/Problem_with_resource.md

@@ -0,0 +1,57 @@
+---
+name: Problem with a resource
+about: If you have a problem, bug, or enhancement with a resource in this resource module.
+---
+<!--
+    Your feedback and support is greatly appreciated, thanks for contributing!
+
+    ISSUE TITLE:
+    Please prefix the issue title with the resource name, e.g.
+    'ResourceName: Short description of my issue'
+
+    ISSUE DESCRIPTION (this template):
+    Please provide information regarding your issue under each header below.
+    Write N/A under any headers that do not apply to your issue, or if the
+    information is not available.
+
+    NOTE! Sensitive information should be obfuscated.
+
+    PLEASE KEEP THE HEADERS.
+
+    You may remove this comment block, and the other comment blocks,
+    but please keep the headers.
+-->
+#### Details of the scenario you tried and the problem that is occurring
+
+#### Verbose logs showing the problem
+
+#### Suggested solution to the issue
+
+#### The DSC configuration that is used to reproduce the issue (as detailed as possible)
+```powershell
+# insert configuration here
+```
+
+#### The operating system the target node is running
+<!--
+    Please provide as much as possible about the target node, for example
+    edition, version, build and language.
+    On OS with WMF 5.1 the following command can help get this information.
+
+    Get-ComputerInfo -Property @(
+        'OsName',
+        'OsOperatingSystemSKU',
+        'OSArchitecture',
+        'WindowsVersion',
+        'WindowsBuildLabEx',
+        'OsLanguage',
+        'OsMuiLanguages')
+-->
+
+#### Version and build of PowerShell the target node is running
+<!--
+    To help with this information, please run this command:
+    $PSVersionTable
+-->
+
+#### Version of the DSC module that was used ('dev' if using current dev branch)

.github/ISSUE_TEMPLATE/Resource_proposal.md

@@ -0,0 +1,21 @@
+---
+name: New resource proposal
+about: If you have a new resource proposal that you think should be added to this resource module.
+---
+<!--
+    Thank you for contributing and making this resource module better!
+
+    ISSUE TITLE:
+    Please prefix the issue title with a proposed resource name,
+    e.g. 'NewResourceName: New resource proposal'
+
+    ISSUE DESCRIPTION (this template):
+    Please propose the new resource under each header below.
+
+    PLEASE KEEP THE HEADERS, but you may remove this comment block.
+-->
+### Description
+
+### Proposed properties
+
+### Special considerations or limitations

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,47 @@
+<!--
+    Thanks for submitting a Pull Request (PR) to this project.
+    Your contribution to this project is greatly appreciated!
+
+    Please prefix the PR title with the resource name,
+    e.g. 'ResourceName: My short description'.
+    If this is a breaking change, then also prefix the PR title
+    with 'BREAKING CHANGE:',
+    e.g. 'BREAKING CHANGE: ResourceName: My short description'.
+
+    You may remove this comment block, and the other comment blocks, but please
+    keep the headers and the task list.
+-->
+#### Pull Request (PR) description
+<!--
+    Replace this comment block with a description of your PR.
+-->
+
+#### This Pull Request (PR) fixes the following issues
+<!--
+    If this PR does not fix an open issue, replace this comment block with None.
+    If this PR resolves one or more open issues, replace this comment block with
+    a list the issues using a GitHub closing keyword, e.g.:
+    - Fixes #123
+    - Fixes #124
+-->
+
+#### Task list
+<!--
+    To aid community reviewers in reviewing and merging your PR, please take
+    the time to run through the below checklist and make sure your PR has
+    everything updated as required.
+
+    Change to [x] for each task in the task list that applies to your PR.
+    For those task that don't apply to you PR, leave those as is.
+-->
+- [ ] Added an entry under the Unreleased section of the change log in the CHANGELOG.md.
+      Entry should say what was changed, and how that affects users (if applicable).
+- [ ] Resource documentation added/updated in README.md.
+- [ ] Resource parameter descriptions added/updated in README.md, schema.mof
+      and comment-based help.
+- [ ] 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 Resource Testing Guidelines](https://github.com/PowerShell/DscResources/blob/master/TestsGuidelines.md).
+- [ ] Integration tests added/updated (where possible). See [DSC Resource Testing Guidelines](https://github.com/PowerShell/DscResources/blob/master/TestsGuidelines.md).
+- [ ] New/changed code adheres to [DSC Resource Style Guidelines](https://github.com/PowerShell/DscResources/blob/master/StyleGuidelines.md) and [Best Practices](https://github.com/PowerShell/DscResources/blob/master/BestPractices.md).

.github/stale.yml

@@ -0,0 +1,44 @@
+# Configuration for probot-stale - https://github.com/probot/stale
+
+limitPerRun: 30
+
+pulls:
+  daysUntilStale: 14
+  daysUntilClose: false
+  exemptProjects: true
+  exemptMilestones: true
+  staleLabel: abandoned
+  exemptLabels:
+    - needs review
+    - on hold
+    - waiting for CLA pass
+
+  markComment: >
+    Labeling this pull request (PR) as abandoned since it has gone 14 days or more
+    since the last update. An abandoned PR can be continued by another contributor.
+    The abandoned label will be removed if work on this PR is taken up again.
+
+issues:
+  daysUntilStale: 30
+  daysUntilClose: 40
+  exemptProjects: true
+  exemptMilestones: true
+  staleLabel: stale
+  exemptLabels:
+    - bug
+    - enhancement
+    - tests
+    - documentation
+    - resource proposal
+    - on hold
+
+  markComment: >
+    This issue has been automatically marked as stale because
+    it has not had activity from the community in the last 30 days. It will be
+    closed if no further activity occurs within 10 days. If the issue is labelled
+    with any of the work labels (e.g bug, enhancement, documentation, or tests)
+    then the issue will not auto-close.
+
+  closeComment: >
+    This issue has been automatically closed because it is has not had activity
+    from the community in the last 40 days.

.vscode/settings.json

@@ -9,5 +9,6 @@
     "powershell.codeFormatting.ignoreOneLineBlock": false,
     "powershell.codeFormatting.preset": "Custom",
     "files.trimTrailingWhitespace": true,
-    "files.insertFinalNewline": true
+    "files.insertFinalNewline": true,
+    "powershell.scriptAnalysis.settingsPath": ".vscode\\analyzersettings.psd1"
 }

CHANGELOG.md

@@ -0,0 +1,70 @@
+# Change log for xBitlocker
+
+## Unreleased
+
+## 1.3.0.0
+
+- Update appveyor.yml to use the default template.
+- Added default template files .gitattributes, and .vscode settings.
+- Fixes most PSScriptAnalyzer issues.
+- Fix issue where AutoUnlock is not set if requested, if the disk was
+  originally encrypted and AutoUnlock was not used.
+- Add remaining Unit Tests for xBitlockerCommon.
+- Add Unit tests for MSFT_xBLTpm
+- Add remaining Unit Tests for xBLAutoBitlocker
+- Add Unit tests for MSFT_xBLBitlocker
+- Moved change log to CHANGELOG.md file
+- Fixed Markdown validation warnings in README.md
+- Added .MetaTestOptIn.json file to root of module
+- Add Integration Tests for module resources
+- Rename functions with improper Verb-Noun constructs
+- Add comment based help to any functions without it
+- Update Schema.mof Description fields
+- Fixes issue where Switch parameters are passed to Enable-Bitlocker even if
+  the corresponding DSC resource parameter was set to False (Issue #12)
+
+## 1.2.0.0
+
+- Converted appveyor.yml to install Pester from PSGallery instead of from
+  Chocolatey.
+- Added Codecov support.
+- Updated appveyor.yml to use the one in template.
+- Added folders for future unit and integration tests.
+- Added Visual Studio Code formatting settings.
+- Added .gitignore file.
+- Added markdown lint rules.
+- Fixed encoding on README.md.
+- Added `PowerShellVersion = '4.0'`, and updated copyright information, in the
+  module manifest.
+- Fixed issue which caused Test to incorrectly succeed on fully decrypted
+  volumes when correct Key Protectors were present
+  ([issue #13](https://github.com/PowerShell/xBitlocker/issues/13))
+- Fixed issue which caused xBLAutoBitlocker to incorrectly detect Fixed vs
+  Removable volumes.
+  ([issue #11](https://github.com/PowerShell/xBitlocker/issues/11))
+- Fixed issue which made xBLAutoBitlocker unable to encrypt volumes with drive
+  letters assigned.
+  ([issue #10](https://github.com/PowerShell/xBitlocker/issues/10))
+- Fixed an issue in CheckForPreReqs function where on Server Core the
+  installation of the non existing Windows Feature
+  'RSAT-Feature-Tools-BitLocker-RemoteAdminTool' was erroneously checked.
+  ([issue #8](https://github.com/PowerShell/xBitlocker/issues/8))
+
+## 1.1.0.0
+
+- Versioning updates
+
+## 1.0.1.1
+
+- Reduced the number of acceptable values for PrimaryProtector in
+  xBLAutoBitlocker and xBLBitlocker.
+- Changed the properties that are returned by Get-TargetResource in
+  xBLAutoBitlocker, xBLBitlocker, and xBLTpm.
+- Fixed issue which caused protectors to be continually re-added.
+
+## 1.0.0.0
+
+- Initial release with the following resources
+  - xBLAutoBitlocker
+  - xBLBitlocker
+  - xBLTpm