feat: use sensible defaults for manifest format

The build orig tarball script will choose a sensible format based
on the version of the source by default:
- .NET 10+ will use the newer json based release manifest format.
- .NET 8 & 9 will use the legacy release manifest format.
- otherwise no release manifest will be created

The behaviour can also be manually specified:
- If the --force-use-legacy-manifest-format flag is specified, the
  legacy release manifest format will be used.
- If the --force-use-json-manifest-format flag is specified, the
  newer json based release manifest format will be used.
- The --force-no-manifest flag will force that no release manifest file
  will be created.

These flags are mutually exclusive.

Signed-off-by: Dominik Viererbe <[email protected]>

Author: dviererbe

.github/workflows/build-orig-tarball.yaml

@@ -11,6 +11,10 @@ on:
         description: 'Git commit-ish (e.g. the tag) of the .NET release'
         required: true
         type: string
+      buildId:
+        description: 'Official Build Id (only needed for .NET 10+)'
+        required: false
+        type: string
       bootstrap:
         description: 'Build bootstraped orig tarballs'
         required: false
@@ -60,7 +64,6 @@ jobs:
             --clone-git-repository "${DOTNET_GIT_REPOSITORY}" \
             --source-version "${{inputs.sourceVersion}}" \
             --git-reference "${{inputs.gitCommitish}}" \
-            --use-legacy-manifest-format \
             --vendor-name "Canonical Ltd." \
             --verbose
 
@@ -101,7 +104,7 @@ jobs:
             --clone-git-repository "${DOTNET_GIT_REPOSITORY}" \
             --source-version "${{inputs.sourceVersion}}" \
             --git-reference "${{inputs.gitCommitish}}" \
-            --use-legacy-manifest-format \
+            --build-id "${{inputs.buildId}}" \
             --vendor-name "Canonical Ltd." \
             --include-bootstrap-sdk \
             --verbose

eng/build-orig-tarball.py

@@ -170,13 +170,27 @@ def __AddManifestOptions(self) -> None:
             help="Name of the organization/person that created the "
                  "orig tarball.")
 
-        manifestGroup.add_argument(
-            "--use-legacy-manifest-format",
-            dest="UseLegacyManifestFormat",
+        manifestFormatGroup = manifestGroup.add_mutually_exclusive_group()
+
+        manifestFormatGroup.add_argument(
+            "--force-no-manifest",
+            dest="ForceNoManifest",
+            action="store_true",
+            help="Force that no release manifest file will be created.")
+
+        manifestFormatGroup.add_argument(
+            "--force-use-legacy-manifest-format",
+            dest="ForceUseLegacyManifestFormat",
             action="store_true",
-            help="Use the legacy (release.info) release manifest format used "
-                 "by earlier Canonical packages. Without this option a "
-                 "manifest.json file will be created.")
+            help="Force the use of the legacy release manifest file format "
+                 "(release.info).")
+
+        manifestFormatGroup.add_argument(
+            "--force-use-json-manifest-format",
+            dest="ForceUseJsonManifestFormat",
+            action="store_true",
+            help="Force the use of the newer json based release manifest file "
+                 "format (release.json).")
 
     def __AddBootstrappingOption(self) -> None:
         bootstrappinGroup = self.add_argument_group("bootstrapping options")
@@ -277,7 +291,19 @@ def __init__(self, args: argparse.Namespace, hostDpkgArchitecture: str):
             LogWarning("Specified .NET security partners repository "
                        "access token was not used")
 
-        self.UseLegacyManifestFormat: bool = args.UseLegacyManifestFormat
+        self.ReleaseManifestFormat: str | None = None
+
+        if args.ForceNoManifest:
+            self.ReleaseManifestFormat = None
+        elif args.ForceUseJsonManifestFormat:
+            self.ReleaseManifestFormat = "json"
+        elif args.ForceUseLegacyManifestFormat:
+            self.ReleaseManifestFormat = "legacy"
+        elif self.DotnetMajorVersion >= 10:
+            self.ReleaseManifestFormat = "json"
+        elif self.DotnetMajorVersion >= 8:
+            self.ReleaseManifestFormat = "legacy"
+
         self.VendorName: str | None = args.VendorName
         self.SourceLinkRepository: str | None = args.SourceLinkRepository
 
@@ -415,7 +441,7 @@ def PrintState(self) -> None:
 - TarballName={self.TarballName}
 
 Manifest options:
-- UseLegacyManifestFormat={self.UseLegacyManifestFormat}
+- ReleaseManifestFormat={self.ReleaseManifestFormat}
 - SourceLinkRepository={self.SourceLinkRepository}
 - VendorName={self.VendorName}
 - BuildId={self.BuildId}
@@ -731,18 +757,22 @@ def GetHeadCommitSha1Hash(context: InvocationContext) -> str:
 
 
 def CreateReleaseManifest(context: InvocationContext) -> None:
+    if context.ReleaseManifestFormat is None:
+        return
+
     sourceRepository = context.SourceLinkRepository
     sourceVersion = GetHeadCommitSha1Hash(context)
     buildIdUnused = False
 
-    if context.UseLegacyManifestFormat:
+    if context.ReleaseManifestFormat == "legacy":
+        releaseManifestFileName = "release.info"
         releaseManifestFileContent = (
             f"RM_GIT_REPO={sourceRepository}\n"
             f"RM_GIT_COMMIT={sourceVersion}")
 
-        releaseManifestFileName = "release.info"
         buildIdUnused = context.BuildId is not None
-    else:
+    elif context.ReleaseManifestFormat == "json":
+        releaseManifestFileName = "release.json"
         releaseManifestData = {
             "sourceRepository": sourceRepository,
             "sourceVersion": sourceVersion,
@@ -759,7 +789,9 @@ def CreateReleaseManifest(context: InvocationContext) -> None:
             buildIdUnused = context.BuildId is not None
 
         releaseManifestFileContent = json.dumps(releaseManifestData, indent=4)
-        releaseManifestFileName = "release.json"
+    else:
+        LogErrorAndExit("Unsupported release manifest format "
+                        f"'{context.ReleaseManifestFormat}'.")
 
     if buildIdUnused:
         LogWarning(f"Build id '{context.BuildId}' is unused")