WebSocket 0.1

Build/GitHub/Jobs/BuildWebSocket.psd1

@@ -0,0 +1,39 @@
+@{
+    "runs-on" = "ubuntu-latest"    
+    if = '${{ success() }}'
+    steps = @(
+        @{
+            name = 'Check out repository'
+            uses = 'actions/checkout@v2'
+        },
+        @{
+            name = 'GitLogger'
+            uses = 'GitLogging/GitLoggerAction@main'
+            id = 'GitLogger'
+        },
+        @{
+            name = 'Use PSSVG Action'
+            uses = 'StartAutomating/PSSVG@main'
+            id = 'PSSVG'
+        },
+        @{
+            name = 'Use PipeScript Action'
+            uses = 'StartAutomating/PipeScript@main'
+            id = 'PipeScript'
+        },        
+        'RunEZOut',
+        'RunHelpOut',
+        @{
+            name = 'Use PSJekyll Action'
+            uses = 'PowerShellWeb/PSJekyll@main'
+            id = 'PSJekyll'
+        },
+        <#@{
+            name = 'Run WebSocket (on branch)'
+            if   = '${{github.ref_name != ''main''}}'
+            uses = './'
+            id = 'WebSocketAction'
+        },#>
+        'BuildAndPublishContainer'
+    )
+}

Build/GitHub/Steps/BuildAndPublishContainer.psd1

@@ -0,0 +1,57 @@
+@{
+    'name'='Log in to ghcr.io'
+    'uses'='docker/login-action@master'
+    'with'=@{
+        'registry'='${{ env.REGISTRY }}'
+        'username'='${{ github.actor }}'
+        'password'='${{ secrets.GITHUB_TOKEN }}'
+    }
+    env = @{
+        'REGISTRY'='ghcr.io'
+    }
+}
+@{
+    name = 'Extract Docker Metadata (for branch)'
+    if   = '${{github.ref_name != ''main'' && github.ref_name != ''master'' && github.ref_name != ''latest''}}'
+    id   = 'meta'
+    uses = 'docker/metadata-action@master'
+    with = @{
+        'images'='${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}'                
+    }
+    env = @{
+        REGISTRY = 'ghcr.io'
+        IMAGE_NAME = '${{ github.repository }}'
+    }
+}
+@{
+    name = 'Extract Docker Metadata (for main)'
+    if   = '${{github.ref_name == ''main'' || github.ref_name == ''master'' || github.ref_name == ''latest''}}'
+    id   = 'metaMain'
+    uses = 'docker/metadata-action@master'
+    with = @{
+        'images'='${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}'
+        'flavor'='latest=true'
+    }
+}
+@{
+    name = 'Build and push Docker image (from main)'
+    if   = '${{github.ref_name == ''main'' || github.ref_name == ''master'' || github.ref_name == ''latest''}}'
+    uses = 'docker/build-push-action@master'
+    with = @{
+        'context'='.'
+        'push'='true'
+        'tags'='${{ steps.metaMain.outputs.tags }}'
+        'labels'='${{ steps.metaMain.outputs.labels }}'
+    }
+}
+@{
+    name = 'Build and push Docker image (from branch)'
+    if   = '${{github.ref_name != ''main'' && github.ref_name != ''master'' && github.ref_name != ''latest''}}'
+    uses = 'docker/build-push-action@master'
+    with = @{
+        'context'='.'
+        'push'='true'
+        'tags'='${{ steps.meta.outputs.tags }}'
+        'labels'='${{ steps.meta.outputs.labels }}'
+    }
+}

Build/WebSocket.GitHubWorkflow.PSDevOps.ps1

@@ -0,0 +1,15 @@
+#requires -Module PSDevOps
+Import-BuildStep -SourcePath (
+    Join-Path $PSScriptRoot 'GitHub'
+) -BuildSystem GitHubWorkflow
+
+Push-Location ($PSScriptRoot | Split-Path)
+New-GitHubWorkflow -Name "Build WebSocket Module" -On Push,
+    PullRequest, 
+    Demand -Job  TestPowerShellOnLinux, 
+    TagReleaseAndPublish, BuildWebSocket -Environment ([Ordered]@{
+        REGISTRY = 'ghcr.io'
+        IMAGE_NAME = '${{ github.repository }}'
+    }) -OutputPath .\.github\workflows\BuildWebSocket.yml
+
+Pop-Location

Build/WebSocket.HelpOut.ps1

@@ -0,0 +1,14 @@
+#requires -Module HelpOut
+
+#region Load the Module
+$ModuleName = 'WebSocket'
+Push-Location ($PSScriptRoot | Split-Path)
+if (-not (Get-Module $ModuleName)) {
+    Import-Module .\ -Global -PassThru | Out-Host
+}
+#endregion Load the Module
+
+# This will save the MarkdownHelp to the docs folder, and output all of the files created.
+Save-MarkdownHelp -PassThru -Module $ModuleName -ExcludeCommandType Alias
+
+Pop-Location

Build/WebSocket.PSJekyll.ps1

@@ -0,0 +1,119 @@
+$sitePath = Join-Path ($PSScriptRoot | Split-Path) 'docs'
+
+$sourceModule = Get-Module PSJekyll
+if (-not $sourceModule) { 
+    $sourceModule = Import-Module ($PSScriptRoot | Split-Path) -PassThru
+} 
+
+
+Push-Location $sitePath
+$PSJekyll.CurrentSite.Domain = "websocket.powershellweb.com"
+$PSJekyll.CurrentSite.Data = @{LastDateBuilt = [datetime]::UtcNow.Date.ToString('yyyy-MM-dd')}
+$PSJekyll.CurrentSite.Data = @{
+    "PSModule/Info" = $sourceModule |
+        Select-Object -Property Name, 
+            Version, 
+            Description, 
+            Copyright, 
+            CompanyName, 
+            Author,
+            @{
+                Name = 'Tags'
+                Expression = { @($_.PrivateData.PSData.Tags | Select-Object -Unique)}
+            }            
+    "PSModule/Exports" = @(
+        foreach ($command in $sourceModule.ExportedCommands.Values) {
+            [Ordered]@{
+                Name = $command.Name
+                CommandType = $command.CommandType
+                Definition = $command.Definition
+                ParameterName = $command.Parameters.Keys
+                Parameter = @(
+                    $command.Parameters.Values | 
+                        Select-Object -Property Name, 
+                            @{
+                                Name='ParameterType'
+                                Expression = { $_.ParameterType.ToString() }
+                            },                            
+                            Position, 
+                            Mandatory, 
+                            ValueFromPipeline, 
+                            ValueFromPipelineByPropertyName, 
+                            ValueFromRemainingArguments, 
+                            HelpMessage
+                )
+            }       
+        }
+    )
+
+    "PSModule/FunctionNames" = $sourceModule.ExportedFunctions.Keys
+    "PSModule/CmdletNames"   = $sourceModule.ExportedCmdlets.Keys
+    "PSModule/AliasNames"    = $sourceModule.ExportedAliases.Keys
+    "PSModule/Aliases" = @($sourceModule.ExportedAliases.Values |
+        ForEach-Object { [Ordered]@{Name=$_.Name;Definition=$_.Definition} })
+
+    "PSModule/VariableNames" = $sourceModule.ExportedVariables.Keys
+    "PSModule/TypeNames"     = $sourceModule.ExportedTypeFiles | 
+        ForEach-Object { (Select-Xml -XPath //Types/Type -Path $_).Node.Name }
+
+}
+$PSJekyll.CurrentSite.Data
+# It is important to use [Ordered], otherwise, the order of the keys will be random.
+# (this will generate more changes than necessary in the git repository, and will be noisier than desired)
+$PSJekyll.CurrentSite.Config = [Ordered]@{
+    title = "WebSocket"
+    description = "Work with WebSockets in PowerShell"
+    url = "https://websocket.powershellweb.com"
+    permalink = 'pretty'
+    palette = 'Konsolas'
+    analyticsId = 'G-R5C30737B2'
+    googleFont = 'Noto Sans'
+    stylesheet = 'https://cdnjs.cloudflare.com/ajax/libs/animate.css/4.1.1/animate.min.css'
+    defaults = @([Ordered]@{
+        values = @{layout='Default'}
+    })
+}
+$PSJekyll.CurrentSite.Config
+
+foreach ($templateMember in $PSJekyll.Template.psobject.Members) {
+    if ($templateMember.Name -notmatch '^(?>layout|include)\p{P}{0,}') {
+        continue
+    }
+    $templateFileType = $matches.0 -replace '\p{P}{0,}$'    
+    $templateFileName = $templateMember.Name -replace "^$([Regex]::Escape($templateFileType))\p{P}{0,}"
+
+    if ($templateMember.Name -notmatch '\.([^\.]+?)$') {
+        $templateFileName += '.html'
+    }
+    $templateOut = 
+        if ($templateMember.Invoke) {
+            $templateMember.Invoke()
+        } else {
+            $templateMember.Value
+        }
+    try {
+        $PSJekyll.CurrentSite.$templateFileType = $templateFileName, $templateOut
+    } catch {
+        $err = $_
+        Write-Error -Message "Failed to set $templateFileName of $templateFileType : $err"
+    }    
+}
+
+$PSJekyll.CurrentSite.Page = 'Tree', "{% include SiteTree.html %}"
+$PSJekyll.CurrentSite.Page = 'Repos', "{% include Repos.md %}"
+$PSJekyll.CurrentSite.Page = 'Releases', "{% include Releases.md %}"
+$PSJekyll.CurrentSite.Page = 'Contibutors', "{% include Contributor.md %}"
+$PSJekyll.CurrentSite.Page = 'Members', "{% include OrgMember.md %}"
+$PSJekyll.CurrentSite.Page = 'Function', "{% include PSFunctions.md %}"
+$PSJekyll.CurrentSite.Page = 'Functions', "{% include PSFunctions.md %}"
+$PSJekyll.CurrentSite.Page = 'Alias', "{% include PSAlias.md %}"
+$PSJekyll.CurrentSite.Page = 'Aliases', "{% include PSAlias.md %}"
+$PSJekyll.CurrentSite.Page = 'Cmdlet', "{% include PSCmdlet.md %}"
+$PSJekyll.CurrentSite.Page = 'Cmdlets', "{% include PSCmdlet.md %}"
+$PSJekyll.CurrentSite.Page = 'PSTag', "{% include PSTag.md %}"
+$PSJekyll.CurrentSite.Page = 'PSTypeName', "{% include PSTypeName.md %}"
+$PSJekyll.CurrentSite.Layout
+$PSJekyll.CurrentSite.Include
+$PSJekyll.CurrentSite.Page
+
+Pop-Location