All Implemented Interfaces:
ExtensionPoint, Describable<Builder>, BuildStep, SimpleBuildStep

public final class Pack extends MSBuildCommand
A build step to run "dotnet pack", creating a NuGet package for a project.
  • Constructor Details

    • Pack

      @DataBoundConstructor public Pack()
      Creates a new "dotnet pack" build step.
  • Method Details

    • addCommandLineArguments

      protected void addCommandLineArguments(@NonNull DotNetArguments args)
      Adds command line arguments for this "dotnet pack" invocation.

      This adds:

      1. Any arguments added by MSBuildCommand.addCommandLineArguments(DotNetArguments).
      2. --force, if requested via setForce(boolean).
      3. --include-source, if requested via setIncludeSource(boolean).
      4. --include-symbols, if requested via setIncludeSymbols(boolean).
      5. --no-build, if requested via setNoBuild(boolean).
      6. --no-dependencies, if requested via setNoDependencies(boolean).
      7. --no-restore, if requested via setNoRestore(boolean).
      8. -r:xxx, if a runtime identifier has been specified via setRuntime(String).
      9. --version-suffix xxx, if a version suffix has been specified via setRuntime(String).
      Overrides:
      addCommandLineArguments in class MSBuildCommand
      Parameters:
      args - The current set of arguments.
    • isForce

      public boolean isForce()
      Determines whether dependency resolution should be forced.
      Returns:
      true when all dependencies should be resolved even if the last restore was successful; false otherwise.
    • setForce

      @DataBoundSetter public void setForce(boolean force)
      Determines whether dependency resolution should be forced.
      Parameters:
      force - true to resolve all dependencies even if the last restore was successful; false otherwise.
    • isIncludeSource

      public boolean isIncludeSource()
      Determines whether symbol packages containing source code should be created.
      Returns:
      true when symbol packages are created containing source code; false otherwise.
    • setIncludeSource

      @DataBoundSetter public void setIncludeSource(boolean includeSource)
      Determines whether symbol packages containing source code should be created.
      Parameters:
      includeSource - true to create symbol packages containing source code; false otherwise.
    • isIncludeSymbols

      public boolean isIncludeSymbols()
      Determines whether symbol packages should be created.
      Returns:
      true when symbol packages are created; false otherwise.
    • setIncludeSymbols

      @DataBoundSetter public void setIncludeSymbols(boolean includeSymbols)
      Determines whether symbol packages should be created.
      Parameters:
      includeSymbols - true to create symbol packages; false otherwise.
    • isNoBuild

      public boolean isNoBuild()
      Determines whether a build should be performed before creating the packages.
      Returns:
      true when neither a restore nor a build will be performed before creating the packages; false otherwise.
    • setNoBuild

      @DataBoundSetter public void setNoBuild(boolean noBuild)
      Determines whether a build should be performed before creating the packages.
      Parameters:
      noBuild - true to perform neither a restore nor a build before creating the packages; false otherwise.
    • isNoDependencies

      public boolean isNoDependencies()
      Determines whether to ignore project-to-project dependencies.
      Returns:
      true when project-to-project dependencies are ignored; false otherwise.
    • setNoDependencies

      @DataBoundSetter public void setNoDependencies(boolean noDependencies)
      Determines whether to ignore project-to-project dependencies.
      Parameters:
      noDependencies - true when project-to-project dependencies should be ignored; false otherwise.
    • isNoRestore

      public boolean isNoRestore()
      Determines whether an implicit restore should be executed as part of this command.
      Returns:
      true when the implicit restore is disabled; false otherwise.
    • setNoRestore

      @DataBoundSetter public void setNoRestore(boolean noRestore)
      Determines whether an implicit restore should be executed as part of this command.
      Parameters:
      noRestore - true to disable the implicit restore; false otherwise.
    • getRuntime

      @CheckForNull public String getRuntime()
      Gets the runtime identifier to use.
      Returns:
      The runtime identifier to use.
    • setRuntime

      @DataBoundSetter public void setRuntime(@CheckForNull String runtime)
      Sets the runtime identifier to use.
      Parameters:
      runtime - The runtime identifier to use.
    • getVersionSuffix

      @CheckForNull public String getVersionSuffix()
      Sets the version suffix to use.
      Returns:
      The version suffix to use.
    • setVersionSuffix

      @DataBoundSetter public void setVersionSuffix(@CheckForNull String versionSuffix)
      Sets the version suffix to use.
      Parameters:
      versionSuffix - The version suffix to use.