feat: publish schemas as zip and within nuget package (#168)

* feat: improve discussion with code rabbit comments

Author: Seddryck

.gitignore

@@ -31,6 +31,7 @@ bld/
 [Ll]og/
 [Ll]ogs/
 .[Pp]ublish/
+.[Ss]chemas/
 
 # Visual Studio 2015/2017 cache/options directory
 .vs/

Packata.sln

@@ -20,6 +20,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Build", "Build", "{95E83BA6
 		github.ps1 = github.ps1
 		GitVersion.yml = GitVersion.yml
 		package.ps1 = package.ps1
+		package-delta-schemas.ps1 = package-delta-schemas.ps1
 	EndProjectSection
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Project", "Project", "{09BDFA96-353F-419D-890A-D9B9045E66DD}"

appveyor.yml

@@ -68,6 +68,8 @@ test_script:
     .\codecov.exe --dir "./.coverage/"
 
 after_test:
+- dotnet tool install -g Schemathief-cli
+- pwsh: .\package-delta-schemas.ps1
 - dotnet pack src/Packata.Core -p:version="%GitVersion_SemVer%" -c Release --include-symbols --no-build --nologo
 - dotnet pack src/Packata.ResourceReaders -p:version="%GitVersion_SemVer%" -c Release --include-symbols --no-build --nologo
 - dotnet pack src/Packata.Provisioners -p:version="%GitVersion_SemVer%" -c Release --include-symbols --no-build --nologo
@@ -76,6 +78,7 @@ after_test:
 artifacts:
 - path: '**\*.nupkg'
 - path: '**\*.snupkg'
+- path: '**\*.zip'
 
 deploy:
 - provider: NuGet
@@ -92,18 +95,26 @@ on_success:
     if (($env:APPVEYOR_REPO_BRANCH -eq "main") -and ($null -eq $env:APPVEYOR_PULL_REQUEST_NUMBER)) {
         if ($env:GitVersion_Patch -eq '0' -or $env:GitVersion_Patch -eq 0) {
             $context = [PSCustomObject] @{
+                Id = $env:APPVEYOR_PULL_REQUEST_NUMBER
                 Owner = ($env:APPVEYOR_REPO_NAME -Split '/')[0]
                 Repository = ($env:APPVEYOR_REPO_NAME -Split '/')[1]
                 SecretToken = $env:github_access_token
             }
             if (-not ($context | Check-Release-Published -Tag "v$($env:GitVersion_SemVer)")) {
+                
                 $context | Publish-Release `
                     -Tag "v$($env:GitVersion_SemVer)" `
                     -Name "$(($env:APPVEYOR_REPO_NAME -Split '/')[1]) $($env:GitVersion_SemVer)" `
                     -ReleaseNotes `
                     -DiscussionCategory 'Announcements'
 
                 Start-Sleep -Seconds 5
+
+                if (Test-Path -Path "./.publish") {
+                    $context | Upload-Release-Assets `
+                        -Tag "v$($env:GitVersion_SemVer)" `
+                        -Path "./.publish"
+                }
             }
         } else {
             Write-Host "No release published on GitHub when patch is not set to zero."

github.ps1

@@ -218,7 +218,8 @@ function Publish-Release {
 		[string] $tag,
 		[string] $name,
         [switch] $releaseNotes,
-		[string] $discussionCategory
+		[string] $discussionCategory,
+        [string] $discussionText
 	)
 	$body = [PSCustomObject]@{
 				tag_name=$tag
@@ -228,6 +229,11 @@ function Publish-Release {
 	if ($discussionCategory) {
 		$body | Add-Member -MemberType NoteProperty -Name 'discussion_category_name' -Value $discussionCategory
 	}
+
+    if ($discussionText) {
+        $body | Add-Member -MemberType NoteProperty -Name 'body' -Value $discussionText
+    }
+
 	$response = Send-GitHub-Post-Request `
 					-Owner $context.Owner `
 					-Repository $context.Repository `
@@ -236,6 +242,24 @@ function Publish-Release {
 					-Body $body
 }
 
+function Get-Body-PR {
+    [CmdletBinding()]
+    Param(
+        [Parameter(Mandatory=$true)]
+        [object] $context
+    )
+
+    $comments = Send-GitHub-Get-Request `
+        -Owner $context.Owner `
+        -Repository $context.Repository `
+        -Segments @("pulls", $context.Id) `
+        -Headers $($context.SecretToken | Get-GitHub-Headers) `
+
+    Write-Host "PR id: $($context.Id)"
+    $parsed = $comments.Content | ConvertFrom-Json
+    return $parsed.body
+}
+
 function Download-Release-Asset {
     [CmdletBinding()]
 	Param(

oups.txt

@@ -0,0 +1,33 @@
+$ErrorActionPreference = 'Stop'
+
+$schemas = @(
+    @{ Class = "Packata.Core.TableDialect";  Url = "https://datapackage.org/profiles/2.0/tabledialect.json"; Output = ".\.schemas\tabledialect.json"; Error = "Failed to generate TableDialect schema" },
+    @{ Class = "Packata.Core.Schema";        Url = "https://datapackage.org/profiles/2.0/tableschema.json";   Output = ".\.schemas\tableschema.json";   Error = "Failed to generate Table schema" },
+    @{ Class = "Packata.Core.Resource";      Url = "https://datapackage.org/profiles/2.0/dataresource.json";  Output = ".\.schemas\dataresource.json";  Error = "Failed to generate Resource schema" },
+    @{ Class = "Packata.Core.DataPackage";   Url = "https://datapackage.org/profiles/2.0/datapackage.json";   Output = ".\.schemas\datapackage.json";   Error = "Failed to generate DataPackage schema" }
+)
+
+$assemblyPath = ".\src\Packata.Core\bin\Release\net8.0\Packata.Core.dll"
+
+$dir = ".\.schemas"    
+    if (Test-Path $dir) {
+        Remove-Item -Recurse -Force $dir
+    }
+    New-Item -Path $dir -ItemType Directory | Out-Null
+
+foreach ($schema in $schemas) {
+    try {
+        Write-Host "Generating schema for $($schema.Class)..."
+        schemathief delta -a $assemblyPath -c $schema.Class -b $schema.Url -x "paths|profile" | Out-File -Encoding UTF8 -FilePath $schema.Output
+    } catch {
+        Write-Error $schema.Error
+        exit 1
+    }
+}
+
+$dir = ".\.publish"    
+if (Test-Path $dir) {
+    Remove-Item -Recurse -Force $dir
+}
+New-Item -Path $dir -ItemType Directory | Out-Null
+7z a .\.publish\schemas-$env:GitVersion_SemVer.zip .\.schemas\*.* | Out-Null

package-delta-schemas.ps1

@@ -14,4 +14,11 @@
     <PackageReference Include="YamlDotNet" Version="16.3.0" />
   </ItemGroup>
 
+  <ItemGroup>
+    <None Include="..\..\.schemas\**\*">
+      <Pack>true</Pack>
+      <PackagePath>contentFiles/any/any/schemas/%(RecursiveDir)%(Filename)%(Extension)</PackagePath>
+    </None>
+  </ItemGroup>
+
 </Project>