makit 0.0.170 → 0.0.172

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ca893d50f58b61946c9d5990fd3ecfce41d16268c43f475181652ea7b5d3104
-  data.tar.gz: 7f94c3dff71442437093145d8270780d3b18313b9b991a26f4cba5829c014ba1
+  metadata.gz: 3d33beba3997ecb2f3df901e594a88a7e297b0b9c668142e95f12e467695522f
+  data.tar.gz: 8379dea16c7a518519e8d911d666cf9d79a1adb241a0e8f1693d3bed54969f8a
 SHA512:
-  metadata.gz: a22daf468412bde6d78ae770ec1a55317d775a600699786c0373b8e280ded8bd841b45462f10f85bd7f7089d38188952de20539989d22fa7aa2c6e2c097e5d22
-  data.tar.gz: 695c6dfeafa745c8836f8287e058e363db3be921a799459fff232dfd7d2dc88d47aef88d4a59d8031733083b281bd75a89ecf3a2aafc9365fb2011848e4478bf
+  metadata.gz: f9050bff2fb06f6f5a265ea874354c13711de49b2a764e603d1fc8505248852c3839164b5e778d5f2cdf06852b14cead94e3e29dce1d0b0f49e75c0ac88a170f
+  data.tar.gz: 0072df008c5b88eef16b6ebec531608a3efd9656028ace1caf7ef5c7566e4c4248165af9af2982346e045d55975888b3d1e7a5fa61b72ef5e8041234d7f8f862

data/lib/makit/nuget.rb

@@ -64,12 +64,156 @@ module Makit
       system("dotnet nuget push #{path} --source #{path}")
     end
 
+    # Publishes a NuGet package to a remote or local NuGet feed
+    #
+    # This method pushes a .nupkg file to a NuGet source using `dotnet nuget push`.
+    # It automatically includes `--skip-duplicate` to avoid errors when the package
+    # version already exists on the feed.
+    #
+    # When an API key is provided, it is used for authentication but is masked
+    # in the console output for security. When no API key is provided (nil or empty),
+    # the `--api-key` flag is omitted, which is useful for:
+    # - Local directory feeds that don't require authentication
+    # - Azure DevOps feeds using Azure CLI authentication
+    # - Feeds with credential providers configured
+    #
+    # @param package [String] Path to the .nupkg file to publish
+    # @param api_key [String, nil] API key for authentication (nil to skip)
+    # @param source [String] NuGet feed URL or source name
+    # @return [void]
+    #
+    # @example Publish to NuGet.org with an API key
+    #   api_key = ENV["NUGET_API_KEY"]
+    #   Makit::NuGet.publish(
+    #     "bin/Release/MyPackage.1.0.0.nupkg",
+    #     api_key,
+    #     "https://api.nuget.org/v3/index.json"
+    #   )
+    #
+    # @example Publish to Azure DevOps feed (using Azure CLI auth, no API key needed)
+    #   # First authenticate with: az login
+    #   Makit::NuGet.publish(
+    #     "artifacts/MyCompany.Utils.1.2.3.nupkg",
+    #     nil,
+    #     "https://pkgs.dev.azure.com/myorg/myproject/_packaging/myfeed/nuget/v3/index.json"
+    #   )
+    #
+    # @example Publish to Azure DevOps feed with PAT token
+    #   pat_token = ENV["AZURE_DEVOPS_PAT"]
+    #   Makit::NuGet.publish(
+    #     "artifacts/MyCompany.Utils.1.2.3.nupkg",
+    #     pat_token,
+    #     "https://pkgs.dev.azure.com/myorg/myproject/_packaging/myfeed/nuget/v3/index.json"
+    #   )
+    #
+    # @example Publish to a local directory feed (no API key)
+    #   Makit::NuGet.publish(
+    #     "bin/Release/MyPackage.1.0.0.nupkg",
+    #     nil,
+    #     "/Users/louie/code/nuget"
+    #   )
+    #
+    # @example Publish to a configured source by name
+    #   # Using a source name configured via `dotnet nuget add source`
+    #   Makit::NuGet.publish(
+    #     "MyPackage.1.0.0.nupkg",
+    #     nil,
+    #     "local"
+    #   )
+    #
+    # @example Publish with API key from secrets management
+    #   api_key = Makit::Secrets.get("NUGET_API_KEY")
+    #   Makit::NuGet.publish(
+    #     "bin/Release/MyPackage.1.0.0.nupkg",
+    #     api_key,
+    #     "https://api.nuget.org/v3/index.json"
+    #   )
+    #
+    # @see publish_to_directory For publishing to local directory feeds with deduplication
+    # @see configure_source For setting up NuGet sources
+    #
     def self.publish(package, api_key, source)
-      # we do not want the api_key echoed to the console, substitute *****
-      puts "dotnet nuget push #{package} --skip-duplicate --api-key ***** --source #{source}"
-      puts `dotnet nuget push #{package} --skip-duplicate --api-key #{api_key} --source #{source}`
+      if api_key.nil? || api_key.to_s.strip.empty?
+        # No API key provided, skip --api-key flag
+        puts "dotnet nuget push #{package} --skip-duplicate --source #{source}"
+        puts `dotnet nuget push #{package} --skip-duplicate --source #{source}`
+      else
+        # we do not want the api_key echoed to the console, substitute *****
+        puts "dotnet nuget push #{package} --skip-duplicate --api-key ***** --source #{source}"
+        puts `dotnet nuget push #{package} --skip-duplicate --api-key #{api_key} --source #{source}`
+      end
     end
 
+    # Publishes a NuGet package to a local directory feed
+    #
+    # This method pushes a .nupkg file to a local directory-based NuGet feed.
+    # If the package already exists at the target location, it skips the push
+    # and displays a message indicating the package is already present.
+    #
+    # The target path follows the standard NuGet directory feed structure:
+    #   {directory}/{package_name}/{version}/{package_name}.{version}.nupkg
+    #
+    # @param nuget_package_path [String] Full path to the .nupkg file to publish
+    # @param directory [String] Path to the local NuGet feed directory
+    # @param package_name [String] Name of the NuGet package (e.g., "MyCompany.MyPackage")
+    # @param version [String] Version of the package (e.g., "1.2.3")
+    # @return [void]
+    #
+    # @example Publish a package to a local feed directory
+    #   # First, configure a local NuGet source named "local"
+    #   Makit::NuGet.configure_source("local", "/Users/louie/code/nuget")
+    #
+    #   # Publish a package to the local feed
+    #   Makit::NuGet.publish_to_directory(
+    #     "/path/to/MyPackage.1.0.0.nupkg",
+    #     "/Users/louie/code/nuget",
+    #     "MyPackage",
+    #     "1.0.0"
+    #   )
+    #   # Creates: /Users/louie/code/nuget/mypackage/1.0.0/mypackage.1.0.0.nupkg
+    #
+    # @example Publish multiple versions of a package
+    #   local_feed = "/Users/louie/code/nuget"
+    #
+    #   # Publish version 1.0.0
+    #   Makit::NuGet.publish_to_directory(
+    #     "artifacts/MyCompany.Utils.1.0.0.nupkg",
+    #     local_feed,
+    #     "MyCompany.Utils",
+    #     "1.0.0"
+    #   )
+    #
+    #   # Publish version 1.0.1
+    #   Makit::NuGet.publish_to_directory(
+    #     "artifacts/MyCompany.Utils.1.0.1.nupkg",
+    #     local_feed,
+    #     "MyCompany.Utils",
+    #     "1.0.1"
+    #   )
+    #
+    # @example Use with a configured "local" source
+    #   # Configure the "local" source if not already configured
+    #   Makit::NuGet.configure_source("local", "/Users/louie/code/nuget")
+    #
+    #   # Get the source directory from the configured sources
+    #   sources = Makit::NuGet.list_sources
+    #   local_source = sources.find { |s| s[:name] == "local" }
+    #   local_dir = local_source[:url] if local_source
+    #
+    #   # Publish to the local source
+    #   if local_dir
+    #     Makit::NuGet.publish_to_directory(
+    #       "bin/Release/MyApp.1.2.3.nupkg",
+    #       local_dir,
+    #       "MyApp",
+    #       "1.2.3"
+    #     )
+    #   end
+    #
+    # @see configure_source For setting up the local NuGet source
+    # @see list_sources For retrieving configured NuGet sources
+    # @see migrate_packages For migrating packages between feeds
+    #
     def self.publish_to_directory(nuget_package_path, directory, package_name, version)
       target_package_path = "#{directory}/#{package_name}/#{version}/#{package_name}.#{version}.nupkg".downcase
       if File.exist?(target_package_path)

data/lib/makit/setup/razorclasslib.rb

@@ -43,13 +43,13 @@ module Makit
         project.save
 
         # Setup the sln, then slnx
-        if (!File.exist?("#{project.name}.slnx"))
-          Makit::DotNet.new_solution(project.name)
-          Makit::DotNet.sln_add_projects(project.name)
-          # migrate the sln to slnx
-          "dotnet sln migrate #{project.name}.sln".run
-          FileUtils.rm_f("#{project.name}.sln") if File.exist?("#{project.name}.slnx")
-        end
+        #if (!File.exist?("#{project.name}.slnx"))
+        #  Makit::DotNet.new_solution(project.name)
+        #  Makit::DotNet.sln_add_projects(project.name)
+        #  # migrate the sln to slnx
+        #  "dotnet sln migrate #{project.name}.sln".run
+        #  FileUtils.rm_f("#{project.name}.sln") if File.exist?("#{project.name}.slnx")
+        #end
         Makit::Logging.default_logger.debug("Project setup completed")
       end
 

data/lib/makit/tasks/update.rb

@@ -5,7 +5,7 @@ task :update do
   "bundle update".run if File.exist?("Gemfile")
   # are there any *.sln files?
   Dir.glob("**/*.sln").each do |sln_file|
-    "dotnet sln migrate #{sln_file}".run
+    #"dotnet sln migrate #{sln_file}".run
     #FileUtils.rm_f(sln_file) if File.exist?(sln_file.gsub(".sln", ".slnx"))
   end
   "dotnet tool update --global dotnet-outdated-tool".run

data/lib/makit/version.rb

@@ -2,7 +2,7 @@
 
 module Makit
   # Static version for now to avoid circular dependency issues
-  #VERSION = "0.0.170"
+  #VERSION = "0.0.172"
 
   # Version management utilities for various file formats
   #

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: makit
 version: !ruby/object:Gem::Version
-  version: 0.0.170
+  version: 0.0.172
 platform: ruby
 authors:
 - Lou Parslow