Skip to content

Commit 3fa33df

Browse files
MariusStorhaugMariusStorhaug
authored
Initial commit
0 parents  commit 3fa33df

35 files changed

Lines changed: 693 additions & 0 deletions

‎.gitattributes‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Needed for publishing of examples, build worker defaults to core.autocrlf=input.
2+
* text eol=autocrlf
3+
4+
*.mof text eol=crlf
5+
*.sh text eol=lf
6+
*.svg eol=lf
7+
8+
# Ensure any exe files are treated as binary
9+
*.exe binary
10+
*.jpg binary
11+
*.xl* binary
12+
*.pfx binary
13+
*.png binary
14+
*.dll binary
15+
*.so binary

‎.github/CODEOWNERS‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners
2+
# Each line is a file pattern followed by one or more owners.
3+
4+
# These owners will be the default owners for everything in
5+
# the repo. Unless a later match takes precedence,
6+
# @global-owner1 and @global-owner2 will be requested for
7+
# review when someone opens a pull request.
8+
* @PSModule/module-maintainers
9+
* @PSModule/framework-maintainers
10+
11+
# Order is important; the last matching pattern takes the most
12+
# precedence. When someone opens a pull request that only
13+
# modifies JS files, only @js-owner and not the global
14+
# owner(s) will be requested for a review.
15+
# *.js @js-owner
16+
17+
# You can also use email addresses if you prefer. They'll be
18+
# used to look up users just like we do for commit author
19+
# emails.
20+
# *.go docs@example.com
21+
22+
# Teams can be specified as code owners as well. Teams should
23+
# be identified in the format @org/team-name. Teams must have
24+
# explicit write access to the repository. In this example,
25+
# the octocats team in the octo-org organization owns all .txt files.
26+
# *.txt @octo-org/octocats
27+
28+
# In this example, @doctocat owns any files in the build/logs
29+
# directory at the root of the repository and any of its
30+
# subdirectories.
31+
# /build/logs/ @doctocat
32+
33+
# The `docs/*` pattern will match files like
34+
# `docs/getting-started.md` but not further nested files like
35+
# `docs/build-app/troubleshooting.md`.
36+
# docs/* docs@example.com
37+
38+
# In this example, @octocat owns any file in an apps directory
39+
# anywhere in your repository.
40+
# apps/ @octocat
41+
42+
# In this example, @doctocat owns any file in the `/docs`
43+
# directory in the root of your repository and any of its
44+
# subdirectories.
45+
# /docs/ @doctocat
46+
47+
# In this example, @octocat owns any file in the `/apps`
48+
# directory in the root of your repository except for the `/apps/github`
49+
# subdirectory, as its owners are left empty.
50+
# /apps/ @octocat
51+
# /apps/github

‎.github/dependabot.yml‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# To get started with Dependabot version updates, you'll need to specify which
2+
# package ecosystems to update and where the package manifests are located.
3+
# Please see the documentation for all configuration options:
4+
# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
5+
6+
version: 2
7+
updates:
8+
- package-ecosystem: github-actions # See documentation for possible values
9+
directory: / # Location of package manifests
10+
schedule:
11+
interval: weekly
12+
- package-ecosystem: nuget # See documentation for possible values
13+
directory: / # Location of package manifests
14+
schedule:
15+
interval: weekly

‎.github/release.yml‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes#configuring-automatically-generated-release-notes
2+
3+
changelog:
4+
exclude:
5+
labels:
6+
- NoRelease
7+
categories:
8+
- title: 🌟 Breaking Changes
9+
labels:
10+
- Major
11+
- Breaking
12+
- title: 🚀 New Features
13+
labels:
14+
- Minor
15+
- Feature
16+
- title: Other Changes
17+
labels:
18+
- '*'

‎.github/workflows/Process-PSModule.yml‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: Process-PSModule
2+
3+
run-name: "Process-PSModule - [${{ github.event.pull_request.title }} #${{ github.event.pull_request.number }}] by @${{ github.actor }}"
4+
5+
on:
6+
pull_request:
7+
branches:
8+
- main
9+
types:
10+
- closed
11+
- opened
12+
- reopened
13+
- synchronize
14+
- labeled
15+
16+
concurrency:
17+
group: ${{ github.workflow }}
18+
19+
permissions:
20+
contents: write
21+
pull-requests: write
22+
23+
jobs:
24+
Process-PSModule:
25+
uses: PSModule/Process-PSModule/.github/workflows/workflow.yml@v1
26+
secrets: inherit

‎.gitignore‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# VS Code files for those working on multiple tools
2+
.vscode/*
3+
!.vscode/settings.json
4+
!.vscode/tasks.json
5+
!.vscode/launch.json
6+
!.vscode/extensions.json
7+
*.code-workspace
8+
9+
# Local History for Visual Studio Code
10+
.history/*
11+
12+
# PSModule framework outputs folder
13+
outputs/*

‎.vscode/extensions.json‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"recommendations": [
3+
"github.vscode-github-actions",
4+
"ms-vscode.powershell"
5+
]
6+
}

‎.vscode/settings.json‎

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
{
2+
"[json]": {
3+
"editor.defaultFormatter": "vscode.json-language-features"
4+
},
5+
"[jsonc]": {
6+
"editor.defaultFormatter": "vscode.json-language-features"
7+
},
8+
"[markdown]": {
9+
"editor.defaultFormatter": "yzhang.markdown-all-in-one",
10+
"editor.quickSuggestions": {
11+
"comments": "off",
12+
"other": "off",
13+
"strings": "off"
14+
},
15+
"editor.wordWrap": "off"
16+
},
17+
"[powershell]": {
18+
"editor.defaultFormatter": "ms-vscode.powershell",
19+
"editor.wordSeparators": "`~!@#%^&*()=+[{]}\\|;:'\",.<>/?",
20+
"files.encoding": "utf8bom"
21+
},
22+
"[yaml]": {
23+
"editor.defaultFormatter": "github.vscode-github-actions",
24+
"editor.insertSpaces": true,
25+
"editor.tabSize": 2,
26+
},
27+
"[github-actions-workflow]": {
28+
"editor.defaultFormatter": "github.vscode-github-actions",
29+
"editor.insertSpaces": true,
30+
"editor.tabSize": 2
31+
},
32+
"editor.rulers": [0, 150],
33+
"powershell.codeFormatting.autoCorrectAliases": true,
34+
"powershell.codeFormatting.newLineAfterCloseBrace": false,
35+
"powershell.codeFormatting.pipelineIndentationStyle": "IncreaseIndentationForFirstPipeline",
36+
"powershell.codeFormatting.preset": "OTBS",
37+
"powershell.codeFormatting.trimWhitespaceAroundPipe": true,
38+
"powershell.codeFormatting.useConstantStrings": true,
39+
"powershell.codeFormatting.useCorrectCasing": true,
40+
"powershell.codeFormatting.whitespaceBetweenParameters": true,
41+
"powershell.pester.codeLens": false,
42+
"powershell.powerShellDefaultVersion": "PowerShell (x64)",
43+
"powershell.scriptAnalysis.enable": true,
44+
"todo-tree.general.tags": [
45+
"BUG",
46+
"HACK",
47+
"FIXME",
48+
"TODO",
49+
"DEBUG"
50+
],
51+
"todo-tree.highlights.customHighlight": {
52+
"TODO": {
53+
"background": "#00ff00",
54+
"foreground": "#ffffff",
55+
"icon": "alert",
56+
"iconColour": "#00ff00",
57+
"type": "text-and-comment"
58+
},
59+
"HACK": {
60+
"background": "#ff0000",
61+
"foreground": "#ffffff",
62+
"icon": "alert",
63+
"iconColour": "#ff0000",
64+
"type": "text-and-comment"
65+
},
66+
"FIXME": {
67+
"background": "#ff0000",
68+
"foreground": "#ffffff",
69+
"icon": "alert",
70+
"iconColour": "#ff0000",
71+
"type": "text-and-comment"
72+
},
73+
"BUG": {
74+
"background": "#ff0000",
75+
"foreground": "#ffffff",
76+
"icon": "alert",
77+
"iconColour": "#ff0000",
78+
"type": "text-and-comment"
79+
}
80+
}
81+
}

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2024 PSModule
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
# PSModuleTemplate
2+
3+
Add a short description about the module and the project.
4+
5+
## Prerequisites
6+
7+
List any prerequisites needed to use the module, such as PowerShell versions, additional modules, or permissions.
8+
9+
## Installation
10+
11+
Provide step-by-step instructions on how to install the module, including any InstallModule commands or manual installation steps.
12+
13+
```powershell
14+
Install-Module -Name YourModuleName
15+
```
16+
17+
## Usage
18+
19+
Here is a list of example that are typical use cases for the module.
20+
This section should provide a good overview of the module's capabilities.
21+
22+
### Example 1
23+
24+
Provide examples for typical commands that a user would like to do with the module.
25+
26+
```powershell
27+
Import-Module -Name PSModuleTemplate
28+
```
29+
30+
### Example 2
31+
32+
Provide examples for typical commands that a user would like to do with the module.
33+
34+
```powershell
35+
Import-Module -Name PSModuleTemplate
36+
```
37+
38+
### Find more examples
39+
40+
To find more examples of how to use the module, please refer to the [examples](examples) folder.
41+
42+
Alternatively, you can use the Get-Command -Module 'This module' to find more commands that are available in the module.
43+
To find examples of each of the commands you can use Get-Help -Examples 'CommandName'.
44+
45+
## Documentation
46+
47+
Link to further documentation if available, or describe where in the repository users can find more detailed documentation about
48+
the module's functions and features.
49+
50+
## Contributing
51+
52+
Coder or not, you can contribute to the project! We welcome all contributions.
53+
54+
### For Users
55+
56+
If you don't code, you still sit on valuable information that can make this project even better. If you experience that the
57+
product does unexpected things, throw errors or is missing functionality, you can help by submitting bugs and feature requests.
58+
Please see the issues tab on this project and submit a new issue that matches your needs.
59+
60+
### For Developers
61+
62+
If you do code, we'd love to have your contributions. Please read the [Contribution guidelines](CONTRIBUTING.md) for more information.
63+
You can either help by picking up an existing issue or submit a new one if you have an idea for a new feature or improvement.
64+
65+
## Acknowledgements
66+
67+
Here is a list of people and projects that helped this project in some way.

0 commit comments

Comments
 (0)