Modernize repository: fix workflows, update scripts, add docs

.github/ISSUE_TEMPLATE/new-repository.yml

@@ -0,0 +1,22 @@
+name: New Repository Request
+description: Request adding a new BattleScribe data repository to the gallery
+title: "Add repository: "
+labels: ["new-repository"]
+body:
+  - type: input
+    id: repo-url
+    attributes:
+      label: Repository URL
+      description: Full GitHub URL of the repository to add
+      placeholder: "https://github.com/owner/repo-name"
+    validations:
+      required: true
+  - type: checkboxes
+    id: prerequisites
+    attributes:
+      label: Prerequisites
+      options:
+        - label: Repository is publicly accessible
+          required: true
+        - label: Repository has the `battlescribe-data` topic
+        - label: Repository has a published release with a `.catpkg.json` asset

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,17 @@
+## Description
+
+<!-- Briefly describe the change -->
+
+## Type of Change
+
+- [ ] New repository registration
+- [ ] Registry entry update/fix
+- [ ] Workflow/script change
+- [ ] Documentation update
+
+## Checklist
+
+- [ ] Entry file is named `<repo-name>.catpkg.yml`
+- [ ] Entry contains valid `location.github` field
+- [ ] Repository is publicly accessible
+- [ ] Repository has the `battlescribe-data` topic (recommended)

.github/actions/install-yaml/action.yml

@@ -5,5 +5,5 @@ runs:
   steps:
     - run: |
         Import-Module powershell-yaml -ErrorAction:Ignore
-        || Install-Module powershell-yaml -RequiredVersion 0.4.2 -Force
+        || Install-Module powershell-yaml -RequiredVersion 0.4.7 -Force
       shell: pwsh

.github/scripts/Update-Registry.ps1

@@ -4,15 +4,16 @@ param (
   [string] $RegistryPath,
 
   [Parameter()]
-  [string] $Token
+  [string] $Token,
+
+  [Parameter()]
+  [string] $ParentOrgName = 'BSData'
 )
 
 #Requires -Version 7
 #Requires -Module powershell-yaml
 
-$parentOrgName = 'BSData'
-
-$query = "topic:battlescribe-data+org:$parentOrgName"
+$query = "topic:battlescribe-data+org:$ParentOrgName"
 $apiRepoSearchArgs = @{
   Method        = 'GET'
   Uri           = "https://api.github.com/search/repositories?q=$query"
@@ -22,7 +23,7 @@ $apiRepoSearchArgs = @{
   }
 }
 if ($Token) {
-  $apiRepoSearchArgs.Headers['Authorization'] = "token $token"
+  $apiRepoSearchArgs.Headers['Authorization'] = "Bearer $Token"
 }
 $apiRepoSearchResult = Invoke-RestMethod @apiRepoSearchArgs
 $repositories = @($apiRepoSearchResult.items | Sort-Object full_name)
@@ -57,7 +58,7 @@ $reposNoLongerExisting = $regEntries | Where-Object {
     # we've got it in API response, so it surely exists
     return $false
   }
-  if ($reponame -match "^$parentOrgName/" -and $reponame -notin $orgRepoNames) {
+  if ($reponame -match "^$ParentOrgName/" -and $reponame -notin $orgRepoNames) {
     # we've not got it in API response and it's from requested org,
     # so it doesn't meet search criteria (e.g. no 'battlescribe-data' topic)
     $_.del_reason = "not found in org repos query results"
@@ -68,7 +69,7 @@ $reposNoLongerExisting = $regEntries | Where-Object {
     Uri                = "https://api.github.com/repos/$reponame"
     StatusCodeVariable = 'status'
     SkipHttpErrorCheck = $true
-    Headers            = ($Token ? @{ Authorization = "token $Token" } : @{})
+    Headers            = ($Token ? @{ Authorization = "Bearer $Token" } : @{})
   }
   $null = Invoke-RestMethod @apiRepoGetArgs
   $notFound = $status -eq 404

.github/scripts/Validate-Registry.ps1

@@ -29,27 +29,16 @@ if ($env:GITHUB_ACTIONS -ne 'true') {
   function LogError($Message, $File) {
     Write-Error "$File`: $Message"
   }
-  function FormatFileRef($props, $msg) {
-    $file = $props['file']
-    $line = $props['line']
-    $col = $props['col']
-    $value = ''
-    if ($file) {
-      $position = $line ? $col ? "($line,$col)" : "($line)" : '';
-      $value += "${file}${position}: "
-    }
-    return $value + $message
-  }
 }
 else {
   function LogDebug($Message) {
-    Write-ActionDebug $Message
+    Write-Host "::debug::$Message"
   }
   function LogWarning($Message, $File) {
-    Write-ActionWarning $Message $File
+    Write-Host "::warning file=$File::$Message"
   }
   function LogError($Message, $File) {
-    Write-ActionError $Message $File
+    Write-Host "::error file=$File::$Message"
   }
 }
 
@@ -82,9 +71,8 @@ Get-ChildItem $entriesDir *.catpkg.yml | Sort-Object Name | ForEach-Object {
     StatusCodeVariable = 'status'
     SkipHttpErrorCheck = $true
     Headers            = @{
-      # preview api for 'topics'
-      Accept = 'application/vnd.github.mercy-preview+json'
-    } + ($Token ? @{ Authorization = "token $Token" } : @{} )
+      Accept = 'application/vnd.github.v3+json'
+    } + ($Token ? @{ Authorization = "Bearer $Token" } : @{} )
   }
   $apiRepo = Invoke-RestMethod @apiRepoArgs
   if ($status -ne 200) {
@@ -106,7 +94,7 @@ Get-ChildItem $entriesDir *.catpkg.yml | Sort-Object Name | ForEach-Object {
     Uri                = "$apiUrl/contents/.github/workflows"
     StatusCodeVariable = 'status'
     SkipHttpErrorCheck = $true
-    Headers            = ($Token ? @{ Authorization = "token $Token" } : @{} )
+    Headers            = ($Token ? @{ Authorization = "Bearer $Token" } : @{} )
   }
   $workflows = Invoke-RestMethod @getWorkflowsArgs
   $addWorkflowsSuggestion = @"

.github/scripts/lib/BsdataGallery/BsdataGallery.psd1

@@ -0,0 +1,16 @@
+@{
+    RootModule        = 'BsdataGallery.psm1'
+    ModuleVersion     = '1.0.0'
+    GUID              = 'a1b2c3d4-e5f6-7890-abcd-ef1234567890'
+    Author            = 'BSData'
+    Description       = 'PowerShell module for BSData Gallery index operations'
+    PowerShellVersion = '7.0'
+    RequiredModules   = @('powershell-yaml')
+    FunctionsToExport = @(
+        'Update-BsdataGalleryIndex'
+        'Get-BsdataGalleryCatpkg'
+    )
+    CmdletsToExport   = @()
+    VariablesToExport  = @()
+    AliasesToExport    = @()
+}

.github/scripts/lib/BsdataGallery/BsdataGallery.psm1

@@ -86,7 +86,7 @@ function Get-GHApiUpdatedResult {
       Headers                 = & {
         $requestHeaders = @{ }
         if ($Token) {
-          $requestHeaders['Authorization'] = "token $Token"
+          $requestHeaders['Authorization'] = "Bearer $Token"
         }
         if ($LastModified) {
           $requestHeaders['If-Modified-Since'] = $LastModified
@@ -172,7 +172,7 @@ function Get-UpdatedCache {
     [string]$Token,
 
     [Parameter()]
-    [string]$DisableLastModifiedCaching
+    [switch]$DisableLastModifiedCaching
   )
 
   # prepare result object
@@ -289,7 +289,7 @@ function Update-BsdataGalleryIndex {
     [string]$Token,
 
     [Parameter()]
-    [string]$DisableLastModifiedCaching
+    [switch]$DisableLastModifiedCaching
   )
 
   # read registry entries

.github/workflows/ci.yml

@@ -12,18 +12,19 @@ jobs:
       - uses: actions/checkout@v4
       - uses: ./.github/actions/install-yaml
       - name: Validate registry
-        uses: Amadevus/pwsh-script@v2
-        with:
-          script: |
-            $ErrorActionPreference = 'Continue'
-            $entries = @()
-            if ($github.base_ref) {
-              # we are in a pull request, let's only check changed entries
-              $baseRefBranch = 'refs/heads/base'
-              git fetch --depth=1 origin "+$($github.base_ref):$baseRefBranch" | Out-Host
-              # get a list of files changed in PR
-              $entries = git diff-tree --no-commit-id --name-only -r HEAD $baseRefBranch
-              Write-Host "Changed files:"
-              $entries | Out-Host
-            }
-            ./.github/scripts/Validate-Registry.ps1 -Entries $entries -Token $github.token
+        shell: pwsh
+        env:
+          GITHUB_TOKEN: ${{ github.token }}
+        run: |
+          $ErrorActionPreference = 'Continue'
+          $entries = @()
+          if ($env:GITHUB_BASE_REF) {
+            # we are in a pull request, let's only check changed entries
+            $baseRefBranch = 'refs/heads/base'
+            git fetch --depth=1 origin "+$($env:GITHUB_BASE_REF):$baseRefBranch" | Out-Host
+            # get a list of files changed in PR
+            $entries = git diff-tree --no-commit-id --name-only -r HEAD $baseRefBranch
+            Write-Host "Changed files:"
+            $entries | Out-Host
+          }
+          ./.github/scripts/Validate-Registry.ps1 -Entries $entries -Token $env:GITHUB_TOKEN