Merge pull request #1 from techthoughts2/Enhancements

Enhancements

.github/CODE_OF_CONDUCT.md

@@ -72,4 +72,4 @@ available at [https://www.contributor-covenant.org/version/1/4/code-of-conduct.h
 
 [homepage]: https://www.contributor-covenant.org
 
-For answers to common questions about this code of conduct, see [https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq)
+For answers to common questions about this code of conduct, see [https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq)

.github/SECURITY.md

@@ -0,0 +1,18 @@
+# Security Policy
+
+## Reporting a Vulnerability
+
+<!--- Use this section to tell people how to report a vulnerability.
+
+Tell them where to go, how often they can expect to get an update on a reported vulnerability, what to expect if the vulnerability is accepted or declined, etc. -->
+
+If you discover a vulnerability in pwshCloudCommands, please follow the _following process_:
+
+1. Open a generic bug issue advising you have discovered a vulnerability.
+   - Avoid sharing specifics or details of the vulnerability in an open GitHub issue.
+2. A repo owner will reach out to you to establish a private form of communication.
+3. We will evaluate the vulnerability and, if necessary, release a fix or mitigating steps to address it. We will contact you to let you know the outcome, and will credit you in the report.
+
+   Please **do not disclose the vulnerability publicly** until a fix is released!
+
+4. Once we have either a) published a fix, or b) declined to address the vulnerability for whatever reason, you are free to publicly disclose it.

.github/workflows/wf_Linux.yml

@@ -5,13 +5,18 @@
 # https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions
 # https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-powershell
 # https://github.com/actions/upload-artifact#where-does-the-upload-go
-# https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#example-including-branches
 name: pwshCloudCommands-Linux
 on:
   pull_request:
+    paths-ignore:
+      - '**.md'
+      - 'docs/**'
     branches-ignore:
       - 'pipeline'
   push:
+    paths-ignore:
+      - '**.md'
+      - 'docs/**'
     branches-ignore:
       - 'pipeline'
 jobs:
@@ -22,7 +27,7 @@ jobs:
       fail-fast: false
     steps:
     - name: Check out repository
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
     - name: Display the path
       shell: pwsh
       run: echo ${env:PATH}
@@ -40,14 +45,15 @@ jobs:
       shell: pwsh
       run: Invoke-Build -File .\src\pwshCloudCommands.build.ps1
     - name: Upload pester results
-      uses: actions/upload-artifact@v2
+      uses: actions/upload-artifact@v3
       with:
         name: pester-results
         path: ./src/Artifacts/testOutput
         if-no-files-found: warn
     - name: Upload zip module archive build
-      uses: actions/upload-artifact@v2
+      uses: actions/upload-artifact@v3
       with:
         name: zip-archive
         path: ./src/Archive
         if-no-files-found: warn
+

.github/workflows/wf_MacOS.yml

@@ -5,13 +5,18 @@
 # https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions
 # https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-powershell
 # https://github.com/actions/upload-artifact#where-does-the-upload-go
-# https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#example-including-branches
 name: pwshCloudCommands-MacOS
 on:
   pull_request:
+    paths-ignore:
+      - '**.md'
+      - 'docs/**'
     branches-ignore:
       - 'pipeline'
   push:
+    paths-ignore:
+      - '**.md'
+      - 'docs/**'
     branches-ignore:
       - 'pipeline'
 jobs:
@@ -22,7 +27,7 @@ jobs:
       fail-fast: false
     steps:
     - name: Check out repository
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
     - name: Display the path
       shell: pwsh
       run: echo ${env:PATH}
@@ -40,14 +45,15 @@ jobs:
       shell: pwsh
       run: Invoke-Build -File .\src\pwshCloudCommands.build.ps1
     - name: Upload pester results
-      uses: actions/upload-artifact@v2
+      uses: actions/upload-artifact@v3
       with:
         name: pester-results
         path: ./src/Artifacts/testOutput
         if-no-files-found: warn
     - name: Upload zip module archive build
-      uses: actions/upload-artifact@v2
+      uses: actions/upload-artifact@v3
       with:
         name: zip-archive
         path: ./src/Archive
         if-no-files-found: warn
+

.github/workflows/wf_Windows.yml

@@ -5,13 +5,18 @@
 # https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions
 # https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-powershell
 # https://github.com/actions/upload-artifact#where-does-the-upload-go
-# https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#example-including-branches
 name: pwshCloudCommands-Windows
 on:
   pull_request:
+    paths-ignore:
+      - '**.md'
+      - 'docs/**'
     branches-ignore:
       - 'pipeline'
   push:
+    paths-ignore:
+      - '**.md'
+      - 'docs/**'
     branches-ignore:
       - 'pipeline'
 jobs:
@@ -22,7 +27,7 @@ jobs:
       fail-fast: false
     steps:
     - name: Check out repository
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
     - name: Display the path
       shell: powershell
       run: echo ${env:PATH}
@@ -46,14 +51,15 @@ jobs:
       shell: powershell
       run: Invoke-Build -File .\src\pwshCloudCommands.build.ps1
     - name: Upload pester results
-      uses: actions/upload-artifact@v2
+      uses: actions/upload-artifact@v3
       with:
         name: pester-results
         path: .\src\Artifacts\testOutput
         if-no-files-found: warn
     - name: Upload zip module archive build
-      uses: actions/upload-artifact@v2
+      uses: actions/upload-artifact@v3
       with:
         name: zip-archive
         path: .\src\Archive
         if-no-files-found: warn
+

.github/workflows/wf_Windows_Core.yml

@@ -5,13 +5,18 @@
 # https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions
 # https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-powershell
 # https://github.com/actions/upload-artifact#where-does-the-upload-go
-# https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#example-including-branches
 name: pwshCloudCommands-Windows-pwsh
 on:
   pull_request:
+    paths-ignore:
+      - '**.md'
+      - 'docs/**'
     branches-ignore:
       - 'pipeline'
   push:
+    paths-ignore:
+      - '**.md'
+      - 'docs/**'
     branches-ignore:
       - 'pipeline'
 jobs:
@@ -22,7 +27,7 @@ jobs:
       fail-fast: false
     steps:
     - name: Check out repository
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
     - name: Display the path
       shell: pwsh
       run: echo ${env:PATH}
@@ -40,14 +45,15 @@ jobs:
       shell: pwsh
       run: Invoke-Build -File .\src\pwshCloudCommands.build.ps1
     - name: Upload pester results
-      uses: actions/upload-artifact@v2
+      uses: actions/upload-artifact@v3
       with:
         name: pester-results
         path: .\src\Artifacts\testOutput
         if-no-files-found: warn
     - name: Upload zip module archive build
-      uses: actions/upload-artifact@v2
+      uses: actions/upload-artifact@v3
       with:
         name: zip-archive
         path: .\src\Archive
         if-no-files-found: warn
+

.readthedocs.yaml

@@ -0,0 +1,25 @@
+# https://docs.readthedocs.io/en/stable/config-file/index.html
+
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
+mkdocs:
+  configuration: mkdocs.yml
+
+python:
+  install:
+    - requirements: docs/requirements.txt
+
+# # Build PDF & ePub
+formats: all
+#   - epub
+#   - pdf

.vscode/settings.json

@@ -1,18 +1,28 @@
 {
+    "markdownlint.config": {
+        "default": true,
+        "MD007": {
+            "indent": 4
+        },
+        "no-hard-tabs": false
+    },
     // When enabled, will trim trailing whitespace when you save a file.
     "files.trimTrailingWhitespace": true,
     // specifies the PowerShell coding style used in this project (https://github.com/PoshCode/PowerShellPracticeAndStyle/issues/81)
     "powershell.codeFormatting.preset": "Stroustrup",
     "cSpell.words": [
         "ACCOUNTID",
+        "autopagination",
         "Backoff",
         "bucketname",
         "buildspec",
+        "Catesta",
         "childtemplates",
         "Clixml",
         "controlplane",
         "Datapoints",
         "datapull",
+        "datetime",
         "Deduplication",
         "discoverability",
         "dotnetcore",
@@ -34,9 +44,11 @@
         "pwshcloudcommands",
         "Redrive",
         "sqseval",
+        "testbucket",
         "xmldatafiles"
     ],
     "cSpell.enableFiletypes": [
+        "!yaml",
         "powershell"
     ]
 }