Merge pull request #1 from techthoughts2/dev

Initial pull to main

.github/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.6.0]
+
+- Initial release.

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,75 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at **[EMAIL REQUIRED]**. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://www.contributor-covenant.org/version/1/4/code-of-conduct.html](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html)
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see [https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq)

.github/CONTRIBUTING.md

@@ -0,0 +1,51 @@
+# Contributing
+
+Thanks for your interest in contributing to the **pwshPlaces Project**.
+
+Whether it's a bug report, new feature, correction, or additional documentation, your feedback and contributions are appreciated.
+
+Please read through this document before submitting any issues or pull requests to ensure all the necessary information is provided to effectively respond to your bug report or contribution.
+
+Please note there is a code of conduct, please follow it in all your interactions with the project.
+
+## Reporting Bugs/Feature Requests
+
+When filing an issue, please check [existing open](https://github.com/techthoughts2/pwshPlaces/issues), or [recently closed](https://github.com/techthoughts2/pwshPlaces/issues?q=is%3Aissue+is%3Aclosed), issues to make sure somebody else hasn't already
+reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
+
+* A reproducible test case or series of steps
+* The version of the module being used
+* Any modifications you've made relevant to the bug
+* Anything unusual about your environment or deployment
+
+## Contributing via Pull Requests
+
+Contributions via pull requests are much appreciated. Before sending a pull request, please ensure that:
+
+1. You are working against the latest source on the *dev* branch.
+2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
+3. You open an issue to discuss any significant work - I'd hate for your time to be wasted.
+
+To send a pull request, please:
+
+1. Fork the repository.
+2. Checkout the *dev* branch
+3. Modify the source; please focus on the specific change you are contributing. Please refrain from code styling changes, it will be harder to focus on your change.
+4. Ensure local tests pass.
+5. Commit to your fork using clear commit messages.
+6. Send a pull request, answering any default questions in the pull request interface.
+
+GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
+[creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
+
+## Finding contributions to work on
+
+Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (dev/bug/duplicate/help wanted/invalid/question/wontfix), looking at any ['help wanted'](https://github.com/techthoughts2/pwshPlaces/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) issues is a great place to start.
+
+## Code of Conduct
+
+This project has a [Code of Conduct](CODE_OF_CONDUCT.md).
+
+## Licensing
+
+See the [LICENSE](LICENSE.txt) file for our project's licensing.

.github/ISSUE_TEMPLATE/bug-report.md

@@ -0,0 +1,39 @@
+---
+name: Bug report
+about: Submit a new bug
+title: Bug report
+labels: 'bug'
+assignees: ''
+
+---
+
+<!--- Provide a general summary of the issue in the Title above -->
+
+### Expected Behavior
+<!--- Tell us what should happen -->
+
+### Current Behavior
+<!--- Tell us what happens instead of the expected behavior -->
+
+### Possible Solution
+<!--- Not obligatory, but suggest a fix/reason for the bug, -->
+
+### Steps to Reproduce
+<!--- Provide a link to a live example, or an unambiguous set of steps to -->
+<!--- reproduce this bug. Include code to reproduce, if relevant -->
+
+1.
+2.
+3.
+4.
+
+### Context (Environment)
+<!--- How has this issue affected you? What are you trying to accomplish? -->
+<!--- Include as many relevant details about the environment where the bug was discovered. -->
+* Operating System and version as reported by `$PSVersionTable.OS`:
+* PowerShell versions as reported by `$PSVersionTable.PSEdition`:
+
+<!--- Provide a general summary of the issue in the Title above -->
+
+### Detailed Description
+<!--- Provide a detailed description of the issue you are facing -->

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: 'Feature request'
+labels: 'enhancement'
+assignees: ''
+
+---
+
+### Description
+<!--- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
+
+### Describe the solution you'd like
+<!--- A clear and concise description of what you want to happen. -->
+
+### Describe any alternatives you've considered
+<!--- A clear and concise description of any alternative solutions or features you've considered. -->
+
+### Additional context
+<!--- Add any other context or screenshots about the feature request here. -->

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,13 @@
+# Pull Request
+
+## Issue
+
+Issue #, if available:
+
+## Description
+
+Description of changes:
+
+## License
+
+By submitting this pull request, I confirm that my contribution is made under the terms of the projects associated license.

.github/workflows/wf_Linux.yml

@@ -0,0 +1,55 @@
+# https://help.github.com/en/actions/automating-your-workflow-with-github-actions
+# https://help.github.com/en/actions/automating-your-workflow-with-github-actions/virtual-environments-for-github-hosted-runners
+# https://help.github.com/en/actions/automating-your-workflow-with-github-actions/software-installed-on-github-hosted-runners
+# https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#using-a-specific-shell
+# https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions
+# https://github.com/actions/upload-artifact#where-does-the-upload-go
+name: pwshPlaces-Linux-Build
+on:
+  push:
+    paths-ignore:
+      - '**.md'
+      - 'media/**'
+      - 'LICENSE'
+  pull_request:
+    paths-ignore:
+      - '**.md'
+      - 'media/**'
+      - 'LICENSE'
+
+jobs:
+  test:
+    name: Run Tests
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+    steps:
+    - name: Check out repository
+      uses: actions/checkout@v2
+    - name: Display the path
+      shell: pwsh
+      run: echo ${env:PATH}
+    - name: Version Display
+      shell: pwsh
+      run: $PSVersionTable
+    - name: Bootstrap
+      shell: pwsh
+      run: ./actions_bootstrap.ps1
+    - name: Test and Build
+      shell: pwsh
+      run: Invoke-Build -File .\src\pwshPlaces.build.ps1
+      env:
+        GoogleAPIKey: ${{ secrets.GoogleAPIKey }}
+        BingAPIKey: ${{ secrets.BingAPIKey }}
+    - name: Upload pester results
+      uses: actions/upload-artifact@v2
+      with:
+        name: pester-results
+        path: ./src/Artifacts/testOutput
+        if-no-files-found: warn
+    - name: Upload zip module archive build
+      uses: actions/upload-artifact@v2
+      with:
+        name: zip-archive
+        path: ./src/Archive
+        if-no-files-found: warn

.github/workflows/wf_MacOS.yml

@@ -0,0 +1,54 @@
+# https://help.github.com/en/actions/automating-your-workflow-with-github-actions
+# https://help.github.com/en/actions/automating-your-workflow-with-github-actions/virtual-environments-for-github-hosted-runners
+# https://help.github.com/en/actions/automating-your-workflow-with-github-actions/software-installed-on-github-hosted-runners
+# https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#using-a-specific-shell
+# https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions
+# https://github.com/actions/upload-artifact#where-does-the-upload-go
+name: pwshPlaces-MacOS-Build
+on:
+  push:
+    paths-ignore:
+      - '**.md'
+      - 'media/**'
+      - 'LICENSE'
+  pull_request:
+    paths-ignore:
+      - '**.md'
+      - 'media/**'
+      - 'LICENSE'
+jobs:
+  test:
+    name: Run Tests
+    runs-on: macOS-latest
+    strategy:
+      fail-fast: false
+    steps:
+    - name: Check out repository
+      uses: actions/checkout@v2
+    - name: Display the path
+      shell: pwsh
+      run: echo ${env:PATH}
+    - name: Version Display
+      shell: pwsh
+      run: $PSVersionTable
+    - name: Bootstrap
+      shell: pwsh
+      run: ./actions_bootstrap.ps1
+    - name: Test and Build
+      shell: pwsh
+      run: Invoke-Build -File .\src\pwshPlaces.build.ps1
+      env:
+        GoogleAPIKey: ${{ secrets.GoogleAPIKey }}
+        BingAPIKey: ${{ secrets.BingAPIKey }}
+    - name: Upload pester results
+      uses: actions/upload-artifact@v2
+      with:
+        name: pester-results
+        path: ./src/Artifacts/testOutput
+        if-no-files-found: warn
+    - name: Upload zip module archive build
+      uses: actions/upload-artifact@v2
+      with:
+        name: zip-archive
+        path: ./src/Archive
+        if-no-files-found: warn

.github/workflows/wf_Windows.yml

@@ -0,0 +1,60 @@
+# https://help.github.com/en/actions/automating-your-workflow-with-github-actions
+# https://help.github.com/en/actions/automating-your-workflow-with-github-actions/virtual-environments-for-github-hosted-runners
+# https://help.github.com/en/actions/automating-your-workflow-with-github-actions/software-installed-on-github-hosted-runners
+# https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#using-a-specific-shell
+# https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions
+# https://github.com/actions/upload-artifact#where-does-the-upload-go
+name: pwshPlaces-Windows-Build
+on:
+  push:
+    paths-ignore:
+      - '**.md'
+      - 'media/**'
+      - 'LICENSE'
+  pull_request:
+    paths-ignore:
+      - '**.md'
+      - 'media/**'
+      - 'LICENSE'
+jobs:
+  test:
+    name: Run Tests
+    runs-on: windows-latest
+    strategy:
+      fail-fast: false
+    steps:
+    - name: Check out repository
+      uses: actions/checkout@v2
+    - name: Display the path
+      shell: powershell
+      run: echo ${env:PATH}
+    - name: Version Display
+      shell: powershell
+      run: $PSVersionTable
+    - name: NuGet Latest
+      shell: powershell
+      run: Install-PackageProvider -Name "NuGet" -Confirm:$false -Force -Verbose
+    - name: PowerShellGet Latest
+      shell: powershell
+      run: Install-Module -Name PowerShellGet -Repository PSGallery -Force
+    - name: Bootstrap
+      shell: powershell
+      run: ./actions_bootstrap.ps1
+    - name: Test and Build
+      shell: powershell
+      run: Invoke-Build -File .\src\pwshPlaces.build.ps1
+      env:
+        GoogleAPIKey: ${{ secrets.GoogleAPIKey }}
+        BingAPIKey: ${{ secrets.BingAPIKey }}
+    - name: Upload pester results
+      uses: actions/upload-artifact@v2
+      with:
+        name: pester-results
+        path: .\src\Artifacts\testOutput
+        if-no-files-found: warn
+    - name: Upload zip module archive build
+      uses: actions/upload-artifact@v2
+      with:
+        name: zip-archive
+        path: .\src\Archive
+        if-no-files-found: warn