a bit of documentation on the pr tag change

StackEng · Sep 20, 2024 · c4ed025 · c4ed025
1 parent 58ccf2a
commit c4ed025
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/cnab/app/container-registry-discovery.ps1 b/cnab/app/container-registry-discovery.ps1
@@ -23,6 +23,12 @@ function Find-ContainerRegistry([string]$imageTag) {
     return $containerRegistryDetails
   }
 
+  # Image tags that are PRs are in the format pr-xxx or yyyy.mm.dd.vv-pr
+  # where:
+  # - xxx is the github pull request number
+  # - yyyy.mm.dd is the date of the release
+  # - vv is the github run number
+  # - pr- and -pr are literals
   function IsPr([string]$imageTag) {
     $isPr = $imageTag -match '(^pr-[0-9]+(-[0-9]+)?$)|([0-9\.]*-pr?$)'
     Write-MinorStep "Is PR: $isPr"