Skip to content

Commit 6d4ea86

Browse files
Merge pull request #1 from techthoughts2/dev
Initial pull to main
2 parents 7a07054 + 8da266a commit 6d4ea86

File tree

86 files changed

+11391
-351
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

86 files changed

+11391
-351
lines changed

.github/CHANGELOG.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [0.6.0]
9+
10+
- Initial release.

.github/CODE_OF_CONDUCT.md

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, sex characteristics, gender identity and expression,
9+
level of experience, education, socio-economic status, nationality, personal
10+
appearance, race, religion, or sexual identity and orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team at **[EMAIL REQUIRED]**. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
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)
72+
73+
[homepage]: https://www.contributor-covenant.org
74+
75+
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

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# Contributing
2+
3+
Thanks for your interest in contributing to the **pwshPlaces Project**.
4+
5+
Whether it's a bug report, new feature, correction, or additional documentation, your feedback and contributions are appreciated.
6+
7+
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.
8+
9+
Please note there is a code of conduct, please follow it in all your interactions with the project.
10+
11+
## Reporting Bugs/Feature Requests
12+
13+
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
14+
reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
15+
16+
* A reproducible test case or series of steps
17+
* The version of the module being used
18+
* Any modifications you've made relevant to the bug
19+
* Anything unusual about your environment or deployment
20+
21+
## Contributing via Pull Requests
22+
23+
Contributions via pull requests are much appreciated. Before sending a pull request, please ensure that:
24+
25+
1. You are working against the latest source on the *dev* branch.
26+
2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
27+
3. You open an issue to discuss any significant work - I'd hate for your time to be wasted.
28+
29+
To send a pull request, please:
30+
31+
1. Fork the repository.
32+
2. Checkout the *dev* branch
33+
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.
34+
4. Ensure local tests pass.
35+
5. Commit to your fork using clear commit messages.
36+
6. Send a pull request, answering any default questions in the pull request interface.
37+
38+
GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
39+
[creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
40+
41+
## Finding contributions to work on
42+
43+
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.
44+
45+
## Code of Conduct
46+
47+
This project has a [Code of Conduct](CODE_OF_CONDUCT.md).
48+
49+
## Licensing
50+
51+
See the [LICENSE](LICENSE.txt) file for our project's licensing.

.github/ISSUE_TEMPLATE/bug-report.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
name: Bug report
3+
about: Submit a new bug
4+
title: Bug report
5+
labels: 'bug'
6+
assignees: ''
7+
8+
---
9+
10+
<!--- Provide a general summary of the issue in the Title above -->
11+
12+
### Expected Behavior
13+
<!--- Tell us what should happen -->
14+
15+
### Current Behavior
16+
<!--- Tell us what happens instead of the expected behavior -->
17+
18+
### Possible Solution
19+
<!--- Not obligatory, but suggest a fix/reason for the bug, -->
20+
21+
### Steps to Reproduce
22+
<!--- Provide a link to a live example, or an unambiguous set of steps to -->
23+
<!--- reproduce this bug. Include code to reproduce, if relevant -->
24+
25+
1.
26+
2.
27+
3.
28+
4.
29+
30+
### Context (Environment)
31+
<!--- How has this issue affected you? What are you trying to accomplish? -->
32+
<!--- Include as many relevant details about the environment where the bug was discovered. -->
33+
* Operating System and version as reported by `$PSVersionTable.OS`:
34+
* PowerShell versions as reported by `$PSVersionTable.PSEdition`:
35+
36+
<!--- Provide a general summary of the issue in the Title above -->
37+
38+
### Detailed Description
39+
<!--- Provide a detailed description of the issue you are facing -->
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: 'Feature request'
5+
labels: 'enhancement'
6+
assignees: ''
7+
8+
---
9+
10+
### Description
11+
<!--- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
12+
13+
### Describe the solution you'd like
14+
<!--- A clear and concise description of what you want to happen. -->
15+
16+
### Describe any alternatives you've considered
17+
<!--- A clear and concise description of any alternative solutions or features you've considered. -->
18+
19+
### Additional context
20+
<!--- Add any other context or screenshots about the feature request here. -->

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Pull Request
2+
3+
## Issue
4+
5+
Issue #, if available:
6+
7+
## Description
8+
9+
Description of changes:
10+
11+
## License
12+
13+
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

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# https://help.github.com/en/actions/automating-your-workflow-with-github-actions
2+
# https://help.github.com/en/actions/automating-your-workflow-with-github-actions/virtual-environments-for-github-hosted-runners
3+
# https://help.github.com/en/actions/automating-your-workflow-with-github-actions/software-installed-on-github-hosted-runners
4+
# https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#using-a-specific-shell
5+
# https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions
6+
# https://github.com/actions/upload-artifact#where-does-the-upload-go
7+
name: pwshPlaces-Linux-Build
8+
on:
9+
push:
10+
paths-ignore:
11+
- '**.md'
12+
- 'media/**'
13+
- 'LICENSE'
14+
pull_request:
15+
paths-ignore:
16+
- '**.md'
17+
- 'media/**'
18+
- 'LICENSE'
19+
20+
jobs:
21+
test:
22+
name: Run Tests
23+
runs-on: ubuntu-latest
24+
strategy:
25+
fail-fast: false
26+
steps:
27+
- name: Check out repository
28+
uses: actions/checkout@v2
29+
- name: Display the path
30+
shell: pwsh
31+
run: echo ${env:PATH}
32+
- name: Version Display
33+
shell: pwsh
34+
run: $PSVersionTable
35+
- name: Bootstrap
36+
shell: pwsh
37+
run: ./actions_bootstrap.ps1
38+
- name: Test and Build
39+
shell: pwsh
40+
run: Invoke-Build -File .\src\pwshPlaces.build.ps1
41+
env:
42+
GoogleAPIKey: ${{ secrets.GoogleAPIKey }}
43+
BingAPIKey: ${{ secrets.BingAPIKey }}
44+
- name: Upload pester results
45+
uses: actions/upload-artifact@v2
46+
with:
47+
name: pester-results
48+
path: ./src/Artifacts/testOutput
49+
if-no-files-found: warn
50+
- name: Upload zip module archive build
51+
uses: actions/upload-artifact@v2
52+
with:
53+
name: zip-archive
54+
path: ./src/Archive
55+
if-no-files-found: warn

.github/workflows/wf_MacOS.yml

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# https://help.github.com/en/actions/automating-your-workflow-with-github-actions
2+
# https://help.github.com/en/actions/automating-your-workflow-with-github-actions/virtual-environments-for-github-hosted-runners
3+
# https://help.github.com/en/actions/automating-your-workflow-with-github-actions/software-installed-on-github-hosted-runners
4+
# https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#using-a-specific-shell
5+
# https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions
6+
# https://github.com/actions/upload-artifact#where-does-the-upload-go
7+
name: pwshPlaces-MacOS-Build
8+
on:
9+
push:
10+
paths-ignore:
11+
- '**.md'
12+
- 'media/**'
13+
- 'LICENSE'
14+
pull_request:
15+
paths-ignore:
16+
- '**.md'
17+
- 'media/**'
18+
- 'LICENSE'
19+
jobs:
20+
test:
21+
name: Run Tests
22+
runs-on: macOS-latest
23+
strategy:
24+
fail-fast: false
25+
steps:
26+
- name: Check out repository
27+
uses: actions/checkout@v2
28+
- name: Display the path
29+
shell: pwsh
30+
run: echo ${env:PATH}
31+
- name: Version Display
32+
shell: pwsh
33+
run: $PSVersionTable
34+
- name: Bootstrap
35+
shell: pwsh
36+
run: ./actions_bootstrap.ps1
37+
- name: Test and Build
38+
shell: pwsh
39+
run: Invoke-Build -File .\src\pwshPlaces.build.ps1
40+
env:
41+
GoogleAPIKey: ${{ secrets.GoogleAPIKey }}
42+
BingAPIKey: ${{ secrets.BingAPIKey }}
43+
- name: Upload pester results
44+
uses: actions/upload-artifact@v2
45+
with:
46+
name: pester-results
47+
path: ./src/Artifacts/testOutput
48+
if-no-files-found: warn
49+
- name: Upload zip module archive build
50+
uses: actions/upload-artifact@v2
51+
with:
52+
name: zip-archive
53+
path: ./src/Archive
54+
if-no-files-found: warn

.github/workflows/wf_Windows.yml

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# https://help.github.com/en/actions/automating-your-workflow-with-github-actions
2+
# https://help.github.com/en/actions/automating-your-workflow-with-github-actions/virtual-environments-for-github-hosted-runners
3+
# https://help.github.com/en/actions/automating-your-workflow-with-github-actions/software-installed-on-github-hosted-runners
4+
# https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#using-a-specific-shell
5+
# https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions
6+
# https://github.com/actions/upload-artifact#where-does-the-upload-go
7+
name: pwshPlaces-Windows-Build
8+
on:
9+
push:
10+
paths-ignore:
11+
- '**.md'
12+
- 'media/**'
13+
- 'LICENSE'
14+
pull_request:
15+
paths-ignore:
16+
- '**.md'
17+
- 'media/**'
18+
- 'LICENSE'
19+
jobs:
20+
test:
21+
name: Run Tests
22+
runs-on: windows-latest
23+
strategy:
24+
fail-fast: false
25+
steps:
26+
- name: Check out repository
27+
uses: actions/checkout@v2
28+
- name: Display the path
29+
shell: powershell
30+
run: echo ${env:PATH}
31+
- name: Version Display
32+
shell: powershell
33+
run: $PSVersionTable
34+
- name: NuGet Latest
35+
shell: powershell
36+
run: Install-PackageProvider -Name "NuGet" -Confirm:$false -Force -Verbose
37+
- name: PowerShellGet Latest
38+
shell: powershell
39+
run: Install-Module -Name PowerShellGet -Repository PSGallery -Force
40+
- name: Bootstrap
41+
shell: powershell
42+
run: ./actions_bootstrap.ps1
43+
- name: Test and Build
44+
shell: powershell
45+
run: Invoke-Build -File .\src\pwshPlaces.build.ps1
46+
env:
47+
GoogleAPIKey: ${{ secrets.GoogleAPIKey }}
48+
BingAPIKey: ${{ secrets.BingAPIKey }}
49+
- name: Upload pester results
50+
uses: actions/upload-artifact@v2
51+
with:
52+
name: pester-results
53+
path: .\src\Artifacts\testOutput
54+
if-no-files-found: warn
55+
- name: Upload zip module archive build
56+
uses: actions/upload-artifact@v2
57+
with:
58+
name: zip-archive
59+
path: .\src\Archive
60+
if-no-files-found: warn

0 commit comments

Comments
 (0)