Initial commit

xoap-io · Oct 9, 2023 · 7af750f · 7af750f
commit 7af750f
Show file tree

Hide file tree

Showing 43 changed files with 1,783 additions and 0 deletions.
diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto
diff --git a/.github/ISSUE_TEMPLATE/General.md b/.github/ISSUE_TEMPLATE/General.md
@@ -0,0 +1,8 @@
+---
+name: General question or documentation update
+about: If you have a general question or documentation update suggestion around the resource module.
+---
+
+<!--
+    Your feedback and support is greatly appreciated, thanks for contributing!
+-->
diff --git a/.github/ISSUE_TEMPLATE/Problem_with_resource.yml b/.github/ISSUE_TEMPLATE/Problem_with_resource.yml
@@ -0,0 +1,86 @@
+name: Problem with a resource
+description: If you have a problem, bug, or enhancement with a resource in this resource module.
+labels: []
+assignees: []
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Please prefix the issue title (above) with the resource name, e.g. 'ResourceName: Short description of my issue'!
+
+        Your feedback and support is greatly appreciated, thanks for contributing!
+  - type: textarea
+    id: description
+    attributes:
+      label: Problem description
+      description: Details of the scenario you tried and the problem that is occurring.
+    validations:
+      required: true
+  - type: textarea
+    id: logs
+    attributes:
+      label: Verbose logs
+      description: |
+        Verbose logs showing the problem. **NOTE! Sensitive information should be obfuscated.** _Will be automatically formatted as plain text._
+      placeholder: |
+        Paste verbose logs here
+      render: text
+    validations:
+      required: true
+  - type: textarea
+    id: configuration
+    attributes:
+      label: DSC configuration
+      description: |
+        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._
+      placeholder: |
+        Paste DSC configuration here
+      render: powershell
+    validations:
+      required: true
+  - type: textarea
+    id: suggestedSolution
+    attributes:
+      label: Suggested solution
+      description: Do you have any suggestions how to solve the issue?
+    validations:
+      required: true
+  - type: textarea
+    id: targetNodeOS
+    attributes:
+      label: Operating system the target node is running
+      description: |
+        Please provide as much as possible about the target node, for example edition, version, build, and language. _Will be automatically formatted as plain text._
+
+        On OS with WMF 5.1 the following command can help get this information: `Get-ComputerInfo -Property @('OsName','OsOperatingSystemSKU','OSArchitecture','WindowsVersion','WindowsBuildLabEx','OsLanguage','OsMuiLanguages')`
+      placeholder: |
+        Add operating system information here
+      render: text
+    validations:
+      required: true
+  - type: textarea
+    id: targetNodePS
+    attributes:
+      label: PowerShell version and build the target node is running
+      description: |
+        Please provide the version and build of PowerShell the target node is running. _Will be automatically formatted as plain text._
+
+        To help with this information, please run this command: `$PSVersionTable`
+      placeholder: |
+        Add PowerShell information here
+      render: text
+    validations:
+      required: true
+  - type: textarea
+    id: moduleVersion
+    attributes:
+      label: xoap-application-packaging-dsc version
+      description: |
+        Please provide the version of the xoap-application-packaging-dsc module that was used. _Will be automatically formatted as plain text._
+
+        To help with this information, please run this command: `Get-Module -Name 'xoap-application-packaging-dsc' -ListAvailable | ft Name,Version,Path`
+      placeholder: |
+        Add module information here
+      render: text
+    validations:
+      required: true
diff --git a/.github/ISSUE_TEMPLATE/Resource_proposal.yml b/.github/ISSUE_TEMPLATE/Resource_proposal.yml
@@ -0,0 +1,39 @@
+name: New resource proposal
+description: If you have a new resource proposal that you think should be added to this resource module.
+title: "NewResourceName: New resource proposal"
+labels: []
+assignees: []
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Please replace `NewResourceName` in the issue title (above) with your proposed resource name.
+
+        Thank you for contributing and making this resource module better!
+  - type: textarea
+    id: description
+    attributes:
+      label: Resource proposal
+      description: Provide information how this resource will/should work and how it will help users.
+    validations:
+      required: true
+  - type: textarea
+    id: proposedProperties
+    attributes:
+      label: Proposed properties
+      description: |
+        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.
+      value: |
+        Property | Type qualifier | Data type | Description | Default value | Allowed values
+        --- | --- | --- | --- | --- | ---
+        PropertyName | Key | String | Detailed description | None | None
+    validations:
+      required: true
+  - type: textarea
+    id: considerations
+    attributes:
+      label: Special considerations or limitations
+      description: |
+        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.
+    validations:
+      required: true
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: "Virtual PowerShell User Group #DSC channel"
+    url: https://dsccommunity.org/community/contact/
+    about: "To talk to the community and maintainers of DSC Community, please visit the #DSC channel."
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,52 @@
+<!--
+    Thanks for submitting a Pull Request (PR) to this project. Your contribution to this project
+    is greatly appreciated!
+
+    Please prefix the PR title with the resource name, e.g. 'ResourceName: My short description'.
+    If this is a breaking change, then also prefix the PR title with 'BREAKING CHANGE:',
+    e.g. 'BREAKING CHANGE: ResourceName: My short description'.
+
+    You may remove this comment block, and the other comment blocks, but please keep the headers
+    and the task list.
+-->
+
+#### Pull Request (PR) description
+
+<!--
+    Replace this comment block with a description of your PR. Also, make sure you have updated the
+    CHANGELOG.md, see the task list below. An entry in the CHANGELOG.md is mandatory for all PRs.
+-->
+
+#### This Pull Request (PR) fixes the following issues
+
+<!--
+    If this PR does not fix an open issue, replace this comment block with None. If this PR
+    resolves one or more open issues, replace this comment block with a list of the issues using
+    a GitHub closing keyword, e.g.:
+
+- Fixes #123
+- Fixes #124
+-->
+
+#### Task list
+
+<!--
+    To aid community reviewers in reviewing and merging your PR, please take the time to run
+    through the below checklist and make sure your PR has everything updated as required.
+
+    Change to [x] for each task in the task list that applies to your PR. For those task that
+    don't apply to you PR, leave those as is.
+-->
+
+- [ ] Added an entry to the change log under the Unreleased section of the file CHANGELOG.md.
+      Entry should say what was changed and how that affects users (if applicable), and
+      reference the issue being resolved (if applicable).
+- [ ] Resource documentation added/updated in README.md.
+- [ ] Resource parameter descriptions added/updated in README.md, schema.mof and comment-based
+      help.
+- [ ] Comment-based help added/updated.
+- [ ] Localization strings added/updated in all localization files as appropriate.
+- [ ] Examples appropriately added/updated.
+- [ ] Unit tests added/updated. See [DSC Community Testing Guidelines](https://dsccommunity.org/guidelines/testing-guidelines).
+- [ ] Integration tests added/updated (where possible). See [DSC Community Testing Guidelines](https://dsccommunity.org/guidelines/testing-guidelines).
+- [ ] New/changed code adheres to [DSC Community Style Guidelines](https://dsccommunity.org/styleguidelines).
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -0,0 +1,19 @@
+---
+version: 2
+updates:
+  - package-ecosystem: github-actions
+    directory: /
+    target-branch: dev
+    schedule:
+      interval: daily
+    labels:
+      - github-actions
+      - dependencies
+  - package-ecosystem: terraform
+    directory: /
+    target-branch: dev
+    schedule:
+      interval: daily
+    labels:
+      - terraform
+      - dependencies
diff --git a/.github/workflows/commit-message-validator.yaml b/.github/workflows/commit-message-validator.yaml
@@ -0,0 +1,12 @@
+name: Commit linter
+on:
+  pull_request:
+    branches: [main, master]
+jobs:
+  commitlint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - uses: wagoid/commitlint-github-action@v5
diff --git a/.github/workflows/dependabot.yaml b/.github/workflows/dependabot.yaml
@@ -0,0 +1,27 @@
+---
+name: Dependabot Pull Request Approve and Merge
+on: pull_request_target
+permissions:
+  pull-requests: write
+  contents: write
+jobs:
+  dependabot:
+    runs-on: ubuntu-latest
+    if: ${{ github.actor == 'dependabot[bot]' }}
+    steps:
+      - name: Dependabot metadata
+        id: dependabot-metadata
+        uses: dependabot/fetch-metadata@v1.6.0
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+      - name: Approve a PR
+        run: gh pr review --approve "$PR_URL"
+        env:
+          PR_URL: ${{ github.event.pull_request.html_url }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - name: Enable auto-merge for Dependabot PRs
+        if: ${{ steps.dependabot-metadata.outputs.update-type != 'version-update:semver-major' }}
+        run: gh pr merge --auto --squash "$PR_URL"
+        env:
+          PR_URL: ${{ github.event.pull_request.html_url }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.github/workflows/megalinter.yaml b/.github/workflows/megalinter.yaml
@@ -0,0 +1,34 @@
+---
+name: Linting files
+on:
+  pull_request:
+    branches: [main, master]
+concurrency:
+  group: ${{ github.ref }}-${{ github.workflow }}
+  cancel-in-progress: true
+jobs:
+  build:
+    name: MegaLinter
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v3
+        with:
+          token: ${{ secrets.PAT || secrets.GITHUB_TOKEN }}
+          fetch-depth: 0
+      - name: MegaLinter
+        id: ml
+        uses: megalinter/megalinter/flavors/terraform@v7.2.1
+        env:
+          VALIDATE_ALL_CODEBASE: true
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          DISABLE: COPYPASTE,SPELL
+          DISABLE_LINTERS: TERRAFORM_TERRASCAN
+      - name: Archive production artifacts
+        if: ${{ success() }} || ${{ failure() }}
+        uses: actions/upload-artifact@v3
+        with:
+          name: MegaLinter reports
+          path: |
+            report
+            mega-linter.log
diff --git a/.github/workflows/tagging.yaml b/.github/workflows/tagging.yaml
@@ -0,0 +1,43 @@
+---
+name: Create tag and release
+
+on:
+  push:
+    branches:
+      - master
+      - main
+
+jobs:
+  tag:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          token: ${{ secrets.PAT || secrets.GITHUB_TOKEN }}
+          fetch-depth: 0
+      - name: Github Tag with semantic versioning
+        # You may pin to the exact commit or the version.
+        # uses: hennejg/github-tag-action@2cd21a8413aa58e36a69cb22e64d5ad20aeb9b99
+        id: tag_version
+        uses: hennejg/github-tag-action@v4.4.0
+        with:
+          tag_prefix: ""
+          # Required for permission to tag the repo.
+          github_token: ${{ secrets.PAT || secrets.GITHUB_TOKEN }}
+      - name: Zip Release
+        # You may pin to the exact commit or the version.
+        # uses: TheDoctor0/zip-release@09336613be18a8208dfa66bd57efafd9e2685657
+        id: zip
+        uses: TheDoctor0/zip-release@0.7.1
+        with:
+          type: 'zip'
+          filename: 'XOAPModuleTemplateDSC_${{ steps.tag_version.outputs.new_tag }}.zip'
+          exclusions: '*.git* /*License/* CONTRIBUTING.md CODEOWNERS.md CODE_OF_CONDUCT.md .pre-commit.yaml .gitignore .gitattributes .github /templates/* New-CompositeResource.ps1 /test/*'
+      - name: Create a GitHub release
+        uses: ncipollo/release-action@v1
+        with:
+          artifacts: 'XOAPModuleTemplateDSC_${{ steps.tag_version.outputs.new_tag }}.zip'
+          tag: ${{ steps.tag_version.outputs.new_tag }}
+          name: ${{ steps.tag_version.outputs.new_tag }}
+          body: ${{ steps.tag_version.outputs.changelog }}