chore(deps): update HLabs.ImageReferences

.nuke/build.schema.json

@@ -34,7 +34,6 @@
         "CleanProjects",
         "PackBinaries",
         "PreRelease",
-        "PreReleaseContainer",
         "PublishBinaries",
         "PublishContainer",
         "Release",

Directory.Packages.props

@@ -5,7 +5,8 @@
     <CentralPackageTransitivePinningEnabled>true</CentralPackageTransitivePinningEnabled>
   </PropertyGroup>
   <ItemGroup>
-    <PackageVersion Include="HLabs.Containers" Version="1.0.0-preview.1" />
+    <PackageVersion Include="HLabs.ImageReferences" Version="1.0.0-preview.2" />
+    <PackageVersion Include="HLabs.ImageReferences.Extensions.Nuke" Version="1.0.0-preview.2" />
     <PackageVersion Include="Humanizer" Version="3.0.1" />
     <PackageVersion Include="IPNetwork2" Version="3.4.853" />
     <PackageVersion Include="JsonSchema.Net" Version="9.0.0" />

build-utils/Build.Utilities/Build.Utilities.csproj

@@ -1,7 +1,8 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <ItemGroup>
-    <PackageReference Include="HLabs.Containers" />
+    <PackageReference Include="HLabs.ImageReferences" />
+    <PackageReference Include="HLabs.ImageReferences.Extensions.Nuke" />
     <PackageReference Include="Humanizer" />
     <PackageReference Include="Semver" />
     <PackageReference Include="Nuke.Common" />

build-utils/Build.Utilities/Versioning/Abstractions/IVersioningStrategy.cs

@@ -1,4 +1,4 @@
-using HLabs.Containers;
+using HLabs.ImageReferences;
 using Semver;
 
 namespace Drift.Build.Utilities.Versioning.Abstractions;
@@ -16,5 +16,5 @@ public interface IReleaseInfo {
 
   Task<string> GetGitTagAsync();
 
-  Task<ICollection<ImageReference>> GetImageReferences();
+  Task<ICollection<QualifiedImageRef>> GetImageReferences();
 }

build-utils/Build.Utilities/Versioning/ReleaseVersioningBase.cs

@@ -1,5 +1,5 @@
 using Drift.Build.Utilities.Versioning.Abstractions;
-using HLabs.Containers;
+using HLabs.ImageReferences;
 using JetBrains.Annotations;
 using Nuke.Common;
 using Nuke.Common.Git;
@@ -40,7 +40,7 @@
     }
   }
 
   [CanBeNull] public IReleaseInfo Release => this;
 
   public abstract Task<SemVersion> GetVersionAsync();
 
@@ -51,9 +51,9 @@
     return _cachedGitTag;
   }
 
-  public virtual async Task<ICollection<ImageReference>> GetImageReferences() {
+  public virtual async Task<ICollection<QualifiedImageRef>> GetImageReferences() {
     return [
-      ImageReference.DockerIo( "hojmark", "drift", await GetVersionAsync() )
+      "hojmark/drift".Image().Qualify( await GetVersionAsync() )
     ];
   }
 

build-utils/Build.Utilities/Versioning/Strategies/ReleaseVersioning.cs

@@ -1,6 +1,6 @@
 using System.Globalization;
 using Drift.Build.Utilities.Versioning.Abstractions;
-using HLabs.Containers;
+using HLabs.ImageReferences;
 using Nuke.Common.Git;
 using Nuke.Common.Tools.GitHub;
 using Octokit;
@@ -15,7 +15,7 @@
   string? customVersion,
   GitRepository repository,
   IGitHubClient gitHubClient
 ) : ReleaseVersioningBase( build, configuration, repository, gitHubClient ) {
   private SemVersion? _cachedVersion;
 
   public override async Task<SemVersion> GetVersionAsync() {
@@ -51,9 +51,9 @@
     return CreateReleaseName( await GetVersionAsync(), includeMetadata: false );
   }
 
-  public override async Task<ICollection<ImageReference>> GetImageReferences() {
+  public override async Task<ICollection<QualifiedImageRef>> GetImageReferences() {
     return [
-      ImageReference.DockerIo( "hojmark", "drift", Tag.Latest ),
+      "hojmark/drift".Image().Qualify( Tag.Latest ),
       ..await base.GetImageReferences()
     ];
   }

build/NukeBuild.Container.cs

@@ -1,10 +1,13 @@
+using System;
 using System.Linq;
 using Drift.Build.Utilities;
-using Drift.Build.Utilities.ContainerImage;
-using HLabs.Containers;
+using HLabs.ImageReferences;
+using HLabs.ImageReferences.Extensions.Nuke;
+using JetBrains.Annotations;
 using Nuke.Common;
 using Nuke.Common.Tools.Docker;
 using Serilog;
+using Versioning;
 
 // ReSharper disable VariableHidesOuterVariable
 // ReSharper disable AllUnderscoreLocalParameterName
@@ -23,23 +26,28 @@ partial class NukeBuild {
   [Parameter( "DockerHubPassword - Required for releasing container images to Docker Hub" )]
   public readonly string DockerHubPassword;
 
+  private static readonly PartialImageRef DriftImage = new("drift");
+  private static readonly PartialImageRef LocalDriftImage = DriftImage.With( Registry.Localhost );
+  private static readonly PartialImageRef DockerHubDriftImage = DriftImage.With( Registry.DockerHub, "hojmark" );
+  [CanBeNull] private QualifiedImageRef _driftImageRef;
+
   Target PublishContainer => _ => _
     .DependsOn( PublishBinaries, CleanArtifacts )
     .Requires( () => Commit )
     .Executes( async () => {
         using var _ = new OperationTimer( nameof(PublishContainer) );
 
-        // TODO use GetContainerImageReferences (.WithRepo(repo))
         var version = await Versioning.Value.GetVersionAsync();
-        var localTagVersion = ImageReference.Localhost( "drift", version );
 
-        // var created = DateTime.UtcNow.ToString( "o", CultureInfo.InvariantCulture ); // o = round-trip format / ISO 8601
+        var tag = new Tag( Guid.NewGuid().ToString( "N" ) );
+        _driftImageRef = LocalDriftImage.Qualify( tag );
 
-        Log.Information( "Building container image {Tag}", localTagVersion );
+        Log.Information( "Building container image..." );
+        // var created = DateTime.UtcNow.ToString( "o", CultureInfo.InvariantCulture ); // o = round-trip format / ISO 8601
         DockerTasks.DockerBuild( s => s
           .SetPath( RootDirectory )
+          .SetTag( _driftImageRef )
           .SetFile( "Containerfile" )
-          .SetTag( localTagVersion )
           .SetLabel(
             // Timestamping prevents the build from being idempotent
             // $"\"org.opencontainers.image.created={created}\"",
@@ -48,12 +56,14 @@ partial class NukeBuild {
           )
         );
 
-        // For convenience, tag the image with dev as well
-        var localTagDev = localTagVersion.WithTag( Tag.Dev );
-        Log.Information( "Re-tagging {LocalTagVersion} -> {LocalTagDev}", localTagVersion, localTagDev );
+        Log.Information( "Built image: {ImageRef}", _driftImageRef );
+
+        Log.Information( "Tagging image..." );
+        // For convenience, tag the image with dev
+        var devTag = LocalDriftImage.Qualify( Tag.Dev );
         DockerTasks.DockerTag( s => s
-          .SetSourceImage( localTagVersion )
-          .SetTargetImage( localTagDev )
+          .SetSourceImage( _driftImageRef )
+          .SetTargetImage( devTag )
         );
       }
     );
@@ -67,20 +77,18 @@ partial class NukeBuild {
     .Executes( async () => {
         using var _ = new OperationTimer( nameof(ReleaseContainer) );
 
-        var version = await Versioning.Value.GetVersionAsync();
-        var local = ImageReference.Localhost( "drift", version );
-        var @public = ( await Versioning.Value.Release!.GetImageReferences() )
+        var publicReferences = ( await Versioning.Value.Release!.GetImageReferences() )
           .OrderBy( LatestLast ) // Pushing 'latest' last will make sure it appears as the most recent tag on Docker Hub
           .ToArray();
 
-        Push( local, @public.ToArray() );
+        Push( _driftImageRef, publicReferences.ToArray() );
 
-        var repos = @public.Select( r => r.Host ).Distinct();
+        var registries = publicReferences.Select( r => r.Registry ).Distinct();
 
-        Log.Information( "🐋 Released to {Repositories}!", string.Join( " and ", repos ) );
+        Log.Information( "🐋 Released to {Registries}!", string.Join( " and ", registries ) );
       }
     );
-
+/*
   /// <summary>
   /// Releases container image to public Docker Hub!
   /// </summary>
@@ -90,45 +98,45 @@ partial class NukeBuild {
     .Executes( async () => {
         using var _ = new OperationTimer( nameof(PreReleaseContainer) );
 
-        var version = await Versioning.Value.GetVersionAsync();
-        var local = ImageReference.Localhost( "drift", version );
-        var publicc = await Versioning.Value.Release!.GetImageReferences();
+        var publicReferences = await Versioning.Value.Release!.GetImageReferences();
 
-        Push( local, publicc.ToArray() );
+        Push( ImageIdDrift, publicReferences.ToArray() );
 
-        var repos = publicc.DistinctBy( r => r.Repository );
+        var registries = publicReferences.DistinctBy( r => r.Registry );
 
-        Log.Information( "🐋 Released to {Repositories}!", string.Join( " and ", repos ) );
+        Log.Information( "🐋 Released to {Registries}!", string.Join( " and ", registries ) );
       }
-    );
+    );*/
 
-  private static int LatestLast( ImageReference r ) {
-    return r.Tag is LatestTag ? 1 : 0;
+  private static int LatestLast( ImageRef r ) {
+    return r.Tag == Tag.Latest ? 1 : 0;
   }
 
-  private void Push( ImageReference source, params ImageReference[] targets ) {
-    ImageReference[] allReferences = [source, ..targets];
-    var loginToDockerHub = allReferences.Any( reference => reference.Host == DockerIoRegistry.Instance );
+  private void Push( QualifiedImageRef source, params QualifiedImageRef[] targets ) {
+    var logInToDockerHub = targets.Any( r => r.Registry == Registry.DockerHub );
 
     try {
-      if ( loginToDockerHub ) {
+      if ( logInToDockerHub ) {
         DockerHubLogin();
       }
 
       Log.Debug(
-        "Pushing {SourceTag} to: {TargetTags}",
+        "Pushing {Source} to: {Targets}",
         source,
         string.Join( ", ", targets.Select( t => t.ToString() ) )
       );
 
       foreach ( var target in targets ) {
-        Log.Debug( "Re-tagging {SourceTag} -> {TargetTag}", source, target );
+        // Unfortunately, Docker (unlike Podman) does not support pushing an image selected by image ID directly to a
+        // registry tag (image ID → registry:tag). A local tag must be created first, which prevents this from being a
+        // single, atomic operation.
+        Log.Debug( "Tagging {Source} with {Target}", source, target );
         DockerTasks.DockerTag( s => s
           .SetSourceImage( source )
           .SetTargetImage( target )
         );
 
-        Log.Information( "Pushing {TargetTag}", target );
+        Log.Information( "Pushing {Target}", target );
         DockerTasks.DockerPush( s => s
           .SetName( target )
         );
@@ -137,27 +145,23 @@ private void Push( ImageReference source, params ImageReference[] targets ) {
       }
     }
     finally {
-      if ( loginToDockerHub ) {
+      if ( logInToDockerHub ) {
         DockerHubLogout();
       }
     }
   }
 
   private void DockerHubLogin() {
     Log.Debug( "Logging in to Docker Hub" );
-
     DockerTasks.DockerLogin( s => s
+      .SetServer( Registry.DockerHub )
       .SetUsername( DockerHubUsername )
       .SetPassword( DockerHubPassword )
-      .SetServer( DockerIoRegistry.Instance )
     );
   }
 
   private static void DockerHubLogout() {
     Log.Debug( "Logging out of Docker Hub" );
-
-    DockerTasks.DockerLogout( s => s
-      .SetServer( "docker.io" )
-    );
+    DockerTasks.DockerLogout( s => s.SetServer( Registry.DockerHub ) );
   }
 }

build/NukeBuild.Release.cs

@@ -29,7 +29,7 @@ internal partial class NukeBuild {
     );
 
   public Target PreRelease => _ => _
-    .DependsOn( PackBinaries, PreReleaseContainer, Test )
+    .DependsOn( PackBinaries, ReleaseContainer, Test )
     .Executes( async () => {
         using var _ = new OperationTimer( nameof(PreRelease) );
 

build/NukeBuild.Test.cs

@@ -4,7 +4,6 @@
 using System.Threading.Tasks;
 using Drift.Build.Utilities;
 using Drift.Build.Utilities.MsBuild;
-using HLabs.Containers;
 using JetBrains.Annotations;
 using Nuke.Common;
 using Nuke.Common.Tooling;
@@ -71,17 +70,16 @@ sealed partial class NukeBuild {
     .Executes( async () => {
         using var _ = new OperationTimer( nameof(TestE2E) );
 
-        var version = await Versioning.Value.GetVersionAsync();
+        var imageRef = _driftImageRef ?? throw new ArgumentNullException( nameof(_driftImageRef) );
+        Log.Information( "Using image {ImageRef}", imageRef );
 
         foreach ( var runtime in SupportedRuntimes ) {
           var driftBinary = Paths.PublishDirectoryForRuntime( runtime ) / "drift";
 
           var envVars = new Dictionary<string, string> {
             // { nameof(EnvVar.DRIFT_BINARY_PATH), driftBinary },
-            { "DRIFT_BINARY_PATH", driftBinary },
-            // TODO use this!
-            // { "DRIFT_CONTAINER_IMAGE_REF", ImageReference.Localhost( "drift", version ).ToString() }
-            { "DRIFT_CONTAINER_IMAGE_REF", ImageReference.Localhost( "drift", version ).ToString() }
+            { "DRIFT_BINARY_PATH", driftBinary }, //
+            { "DRIFT_CONTAINER_IMAGE_REF", imageRef.ToString() }
           };
 
           var alternateDockerHost = await FindAlternateDockerHostAsync();

build/Versioning/SemVersionExtensions.cs

@@ -4,6 +4,9 @@
 namespace Versioning;
 
 internal static class SemVersionExtensions {
+  /*
+   * NUKE build extensions
+   */
   internal static DotNetBuildSettings SetVersionProperties(
     this DotNetBuildSettings settings,
     SemVersion version
@@ -27,7 +30,6 @@ SemVersion version
   /*
    * Below methods skips metadata because .NET add the commit hash by itself (somewhere?)
    */
-
   internal static string ToDotNetAssemblyVersion( this SemVersion version ) {
     // Takes major.minor.patch and optional build number
     return version.WithoutPrereleaseOrMetadata().ToString();

build/Versioning/TagExtensions.cs

@@ -0,0 +1,9 @@
+using HLabs.ImageReferences;
+
+namespace Versioning;
+
+internal static class TagExtensions {
+  extension( Tag ) {
+    public static Tag Dev => new("dev");
+  }
+}

build/_build.csproj

@@ -13,7 +13,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="HLabs.Containers" />
+    <PackageReference Include="HLabs.ImageReferences" />
     <PackageReference Include="Octokit" />
     <PackageReference Include="Semver" />
     <PackageReference Include="Nuke.Common" />

src/Cli.E2ETests/Cli.E2ETests.csproj

@@ -13,7 +13,7 @@
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="HLabs.Containers" />
+    <PackageReference Include="HLabs.ImageReferences" />
     <PackageReference Include="Microsoft.NET.Test.Sdk" />
     <PackageReference Include="Nuke.Common" />
     <PackageReference Include="NUnit" />