Skip to content

Commit 765aca3

Browse files
MariusStorhaugMariusStorhaug
authored
[FX] Adding initial module file and PSModule framework (#15)
- Adds basic git, dx and repo files - Adds dependabot config - Adds the basic PSModule framework - Fixes #14 - Adds initial GitHub module files
1 parent bea1b2a commit 765aca3

File tree

14 files changed

+488
-2
lines changed

14 files changed

+488
-2
lines changed

‎.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/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/workflows/Module.GitHub.yml

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: Module [GitHub]
2+
3+
on:
4+
push:
5+
branches:
6+
- '*'
7+
paths:
8+
- .github/workflows/Module.GitHub.yml
9+
- src/GitHub/**
10+
workflow_dispatch:
11+
12+
jobs:
13+
BuildModule:
14+
name: Build Module
15+
runs-on: ubuntu-latest
16+
env:
17+
GH_TOKEN: ${{ github.token }} # Used for GitHub CLI authentication
18+
steps:
19+
- name: Checkout Code
20+
uses: actions/checkout@v4
21+
22+
- name: Build Module
23+
uses: PSModule/Build-Module@main
24+
with:
25+
Verbose: true
26+
27+
- name: Test Module
28+
uses: PSModule/Test-Module@main
29+
with:
30+
Verbose: true
31+
32+
- name: Release Module
33+
uses: PSModule/Release-Module@main
34+
with:
35+
APIKey: ${{ secrets.APIKEY }}
36+
Verbose: true

‎.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+
# The Powershell build 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: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
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+
"powershell.codeFormatting.autoCorrectAliases": true,
33+
"powershell.codeFormatting.newLineAfterCloseBrace": false,
34+
"powershell.codeFormatting.pipelineIndentationStyle": "IncreaseIndentationForFirstPipeline",
35+
"powershell.codeFormatting.preset": "OTBS",
36+
"powershell.codeFormatting.trimWhitespaceAroundPipe": true,
37+
"powershell.codeFormatting.useConstantStrings": true,
38+
"powershell.codeFormatting.useCorrectCasing": true,
39+
"powershell.codeFormatting.whitespaceBetweenParameters": true,
40+
"powershell.pester.codeLens": false,
41+
"powershell.powerShellDefaultVersion": "PowerShell (x64)",
42+
"powershell.scriptAnalysis.enable": true,
43+
"todo-tree.general.tags": [
44+
"BUG",
45+
"HACK",
46+
"FIXME",
47+
"TODO",
48+
"DEBUG"
49+
],
50+
"todo-tree.highlights.customHighlight": {
51+
"TODO": {
52+
"background": "#00ff00",
53+
"foreground": "#ffffff",
54+
"icon": "alert",
55+
"iconColour": "#00ff00",
56+
"type": "text-and-comment"
57+
},
58+
"HACK": {
59+
"background": "#ff0000",
60+
"foreground": "#ffffff",
61+
"icon": "alert",
62+
"iconColour": "#ff0000",
63+
"type": "text-and-comment"
64+
},
65+
"FIXME": {
66+
"background": "#ff0000",
67+
"foreground": "#ffffff",
68+
"icon": "alert",
69+
"iconColour": "#ff0000",
70+
"type": "text-and-comment"
71+
},
72+
"BUG": {
73+
"background": "#ff0000",
74+
"foreground": "#ffffff",
75+
"icon": "alert",
76+
"iconColour": "#ff0000",
77+
"type": "text-and-comment"
78+
}
79+
}
80+
}

‎CODE_OF_CONDUCT.md

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, religion, or sexual identity
10+
and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
* Demonstrating empathy and kindness toward other people
21+
* Being respectful of differing opinions, viewpoints, and experiences
22+
* Giving and gracefully accepting constructive feedback
23+
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the
26+
overall community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or
31+
advances of any kind
32+
* Trolling, insulting or derogatory comments, and personal or political attacks
33+
* Public or private harassment
34+
* Publishing others' private information, such as a physical or email
35+
address, without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at
63+
[email protected].
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series
86+
of actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or
93+
permanent ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within
113+
the community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.0, available at
119+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
120+
121+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
122+
enforcement ladder](https://github.com/mozilla/diversity).
123+
124+
[homepage]: https://www.contributor-covenant.org
125+
126+
For answers to common questions about this code of conduct, see the FAQ at
127+
https://www.contributor-covenant.org/faq. Translations are available at
128+
https://www.contributor-covenant.org/translations.

‎LICENSE.md

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) 2022 Marius Storhaug
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.

0 commit comments

Comments
 (0)