Skip to content

Commit d7efde2

Browse files
authored
Initial commit
0 parents  commit d7efde2

Some content is hidden

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

41 files changed

+1528
-0
lines changed

.gitattributes

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Auto detect text files and perform LF normalization
2+
* text=auto

.github/ISSUE_TEMPLATE/General.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
name: General question or documentation update
3+
about: If you have a general question or documentation update suggestion around the resource module.
4+
---
5+
6+
<!--
7+
Your feedback and support is greatly appreciated, thanks for contributing!
8+
-->
Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
name: Problem with a resource
2+
description: If you have a problem, bug, or enhancement with a resource in this resource module.
3+
labels: []
4+
assignees: []
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Please prefix the issue title (above) with the resource name, e.g. 'ResourceName: Short description of my issue'!
10+
11+
Your feedback and support is greatly appreciated, thanks for contributing!
12+
- type: textarea
13+
id: description
14+
attributes:
15+
label: Problem description
16+
description: Details of the scenario you tried and the problem that is occurring.
17+
validations:
18+
required: true
19+
- type: textarea
20+
id: logs
21+
attributes:
22+
label: Verbose logs
23+
description: |
24+
Verbose logs showing the problem. **NOTE! Sensitive information should be obfuscated.** _Will be automatically formatted as plain text._
25+
placeholder: |
26+
Paste verbose logs here
27+
render: text
28+
validations:
29+
required: true
30+
- type: textarea
31+
id: configuration
32+
attributes:
33+
label: DSC configuration
34+
description: |
35+
The DSC configuration that is used to reproduce the issue (as detailed as possible). **NOTE! Sensitive information should be obfuscated.** _Will be automatically formatted as PowerShell code._
36+
placeholder: |
37+
Paste DSC configuration here
38+
render: powershell
39+
validations:
40+
required: true
41+
- type: textarea
42+
id: suggestedSolution
43+
attributes:
44+
label: Suggested solution
45+
description: Do you have any suggestions how to solve the issue?
46+
validations:
47+
required: true
48+
- type: textarea
49+
id: targetNodeOS
50+
attributes:
51+
label: Operating system the target node is running
52+
description: |
53+
Please provide as much as possible about the target node, for example edition, version, build, and language. _Will be automatically formatted as plain text._
54+
55+
On OS with WMF 5.1 the following command can help get this information: `Get-ComputerInfo -Property @('OsName','OsOperatingSystemSKU','OSArchitecture','WindowsVersion','WindowsBuildLabEx','OsLanguage','OsMuiLanguages')`
56+
placeholder: |
57+
Add operating system information here
58+
render: text
59+
validations:
60+
required: true
61+
- type: textarea
62+
id: targetNodePS
63+
attributes:
64+
label: PowerShell version and build the target node is running
65+
description: |
66+
Please provide the version and build of PowerShell the target node is running. _Will be automatically formatted as plain text._
67+
68+
To help with this information, please run this command: `$PSVersionTable`
69+
placeholder: |
70+
Add PowerShell information here
71+
render: text
72+
validations:
73+
required: true
74+
- type: textarea
75+
id: moduleVersion
76+
attributes:
77+
label: xoap-application-packaging-dsc version
78+
description: |
79+
Please provide the version of the xoap-application-packaging-dsc module that was used. _Will be automatically formatted as plain text._
80+
81+
To help with this information, please run this command: `Get-Module -Name 'xoap-application-packaging-dsc' -ListAvailable | ft Name,Version,Path`
82+
placeholder: |
83+
Add module information here
84+
render: text
85+
validations:
86+
required: true
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: New resource proposal
2+
description: If you have a new resource proposal that you think should be added to this resource module.
3+
title: "NewResourceName: New resource proposal"
4+
labels: []
5+
assignees: []
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Please replace `NewResourceName` in the issue title (above) with your proposed resource name.
11+
12+
Thank you for contributing and making this resource module better!
13+
- type: textarea
14+
id: description
15+
attributes:
16+
label: Resource proposal
17+
description: Provide information how this resource will/should work and how it will help users.
18+
validations:
19+
required: true
20+
- type: textarea
21+
id: proposedProperties
22+
attributes:
23+
label: Proposed properties
24+
description: |
25+
List all the proposed properties that the resource should have (key, required, write, and/or read). For each property provide a detailed description, the data type, if a default value should be used, and if the property is limited to a set of values.
26+
value: |
27+
Property | Type qualifier | Data type | Description | Default value | Allowed values
28+
--- | --- | --- | --- | --- | ---
29+
PropertyName | Key | String | Detailed description | None | None
30+
validations:
31+
required: true
32+
- type: textarea
33+
id: considerations
34+
attributes:
35+
label: Special considerations or limitations
36+
description: |
37+
Provide any considerations or limitations you can think of that a contributor should take in account when coding the proposed resource, and or what limitations a user will encounter or should consider when using the proposed resource.
38+
validations:
39+
required: true

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: "Virtual PowerShell User Group #DSC channel"
4+
url: https://dsccommunity.org/community/contact/
5+
about: "To talk to the community and maintainers of DSC Community, please visit the #DSC channel."

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Description
2+
3+
Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this change.
4+
5+
Fixes # (issue)
6+
7+
## Type of change
8+
9+
Please delete options that are not relevant.
10+
11+
- [ ] Bug fix (non-breaking change which fixes an issue)
12+
- [ ] New feature (non-breaking change which adds functionality)
13+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
14+
- [ ] This change requires a documentation update
15+
16+
# How Has This Been Tested?
17+
18+
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
19+
20+
- [ ] Test A
21+
- [ ] Test B
22+
23+
24+
# Checklist:
25+
26+
- [ ] My code follows the style guidelines of this project
27+
- [ ] I have performed a self-review of my code
28+
- [ ] I have commented my code, particularly in hard-to-understand areas
29+
- [ ] I have made corresponding changes to the documentation
30+
- [ ] My changes generate no new warnings
31+
- [ ] I have added tests or screenshots that prove my fix is effective or that my feature works
32+
- [ ] Any dependent changes have been merged and published in downstream modules
33+

.github/dependabot.yml

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
version: 2
3+
updates:
4+
- package-ecosystem: github-actions
5+
directory: /
6+
target-branch: dev
7+
schedule:
8+
interval: daily
9+
labels:
10+
- github-actions
11+
- dependencies
12+
- package-ecosystem: terraform
13+
directory: /
14+
target-branch: dev
15+
schedule:
16+
interval: daily
17+
labels:
18+
- terraform
19+
- dependencies

.github/labeler.yml

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
Feature:
2+
- head-branch: ['^feature', 'feature']
3+
Hotfix:
4+
- head-branch: ['^hotfix', 'hotfix']
5+
Documentation:
6+
- changed-files:
7+
- any-glob-to-any-file: '**/*.md'
8+
CICD:
9+
- changed-files:
10+
- any-glob-to-any-file: '.github/**'
11+
12+
typescript:
13+
- changed-files:
14+
- any-glob-to-any-file: '**/*.ts'
15+
css:
16+
- changed-files:
17+
- any-glob-to-any-file: '**/*.css'
18+
19+

.github/reviewers.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
reviewers:
2+
defaults:
3+
- repository-owners
4+
- bbrauneck
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
name: Commit linter
2+
on:
3+
pull_request:
4+
branches: [main, master]
5+
jobs:
6+
commitlint:
7+
runs-on: ubuntu-latest
8+
steps:
9+
- uses: actions/checkout@v3
10+
with:
11+
fetch-depth: 0
12+
- uses: wagoid/commitlint-github-action@v5

.github/workflows/dependabot.yaml

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
name: Dependabot Pull Request Approve and Merge
3+
on: pull_request_target
4+
permissions:
5+
pull-requests: write
6+
contents: write
7+
jobs:
8+
dependabot:
9+
runs-on: ubuntu-latest
10+
if: ${{ github.actor == 'dependabot[bot]' }}
11+
steps:
12+
- name: Dependabot metadata
13+
id: dependabot-metadata
14+
uses: dependabot/[email protected]
15+
with:
16+
github-token: ${{ secrets.GITHUB_TOKEN }}
17+
- name: Approve a PR
18+
run: gh pr review --approve "$PR_URL"
19+
env:
20+
PR_URL: ${{ github.event.pull_request.html_url }}
21+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
22+
- name: Enable auto-merge for Dependabot PRs
23+
if: ${{ steps.dependabot-metadata.outputs.update-type != 'version-update:semver-major' }}
24+
run: gh pr merge --auto --squash "$PR_URL"
25+
env:
26+
PR_URL: ${{ github.event.pull_request.html_url }}
27+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/labelling.yaml

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
name: label PRs
2+
on:
3+
pull_request:
4+
branches: [dev, master]
5+
jobs:
6+
size-label:
7+
needs: pr-reviewer
8+
permissions:
9+
contents: read
10+
pull-requests: write
11+
runs-on: ubuntu-latest
12+
steps:
13+
- name: size-label
14+
uses: "pascalgn/[email protected]"
15+
env:
16+
GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
17+
with:
18+
sizes: >
19+
{
20+
"0": "XS",
21+
"20": "S",
22+
"50": "M",
23+
"200": "L",
24+
"800": "XL",
25+
"2000": "XXL"
26+
}
27+
- name: general-labels
28+
uses: actions/labeler@v5
29+
with:
30+
sync-labels: true
31+
pr-reviewer:
32+
permissions:
33+
contents: read
34+
pull-requests: write
35+
runs-on: ubuntu-latest
36+
steps:
37+
- name: Checkout
38+
uses: actions/checkout@v3
39+
with:
40+
token: ${{ secrets.PAT || secrets.GITHUB_TOKEN }}
41+
fetch-depth: 0
42+
- name: Request review and assign
43+
uses: necojackarc/[email protected]
44+
with:
45+
token: ${{ secrets.GITHUB_TOKEN }}
46+
config: .github/reviewers.yml
47+
use_local: true

.github/workflows/megalinter.yaml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
name: Linting files
3+
on:
4+
pull_request:
5+
branches: [main, master]
6+
concurrency:
7+
group: ${{ github.ref }}-${{ github.workflow }}
8+
cancel-in-progress: true
9+
jobs:
10+
build:
11+
name: MegaLinter
12+
runs-on: ubuntu-latest
13+
steps:
14+
- name: Checkout Code
15+
uses: actions/checkout@v3
16+
with:
17+
token: ${{ secrets.PAT || secrets.GITHUB_TOKEN }}
18+
fetch-depth: 0

.github/workflows/tagging.yaml

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
name: Create tag and release
3+
4+
on:
5+
push:
6+
branches:
7+
- master
8+
- main
9+
10+
jobs:
11+
tag:
12+
runs-on: ubuntu-latest
13+
steps:
14+
- name: Checkout
15+
uses: actions/checkout@v3
16+
with:
17+
token: ${{ secrets.PAT || secrets.GITHUB_TOKEN }}
18+
fetch-depth: 0
19+
- name: Github Tag with semantic versioning
20+
# You may pin to the exact commit or the version.
21+
# uses: hennejg/github-tag-action@2cd21a8413aa58e36a69cb22e64d5ad20aeb9b99
22+
id: tag_version
23+
uses: hennejg/[email protected]
24+
with:
25+
tag_prefix: ""
26+
# Required for permission to tag the repo.
27+
github_token: ${{ secrets.PAT || secrets.GITHUB_TOKEN }}
28+
- name: Zip Release
29+
# You may pin to the exact commit or the version.
30+
# uses: TheDoctor0/zip-release@09336613be18a8208dfa66bd57efafd9e2685657
31+
id: zip
32+
uses: TheDoctor0/[email protected]
33+
with:
34+
type: 'zip'
35+
filename: 'XOAPModuleTemplateDSC_${{ steps.tag_version.outputs.new_tag }}.zip'
36+
exclusions: '*.git* /*License/* CONTRIBUTING.md CODEOWNERS.md CODE_OF_CONDUCT.md .pre-commit.yaml .gitignore .gitattributes .github /templates/* New-CompositeResource.ps1 /test/*'
37+
- name: Create a GitHub release
38+
uses: ncipollo/release-action@v1
39+
with:
40+
artifacts: 'XOAPModuleTemplateDSC_${{ steps.tag_version.outputs.new_tag }}.zip'
41+
tag: ${{ steps.tag_version.outputs.new_tag }}
42+
name: ${{ steps.tag_version.outputs.new_tag }}
43+
body: ${{ steps.tag_version.outputs.changelog }}

0 commit comments

Comments
 (0)