Contents

# frozen_string_literal: true

require 'bolt/util/format'

# Output a message for the user.
#
# This will print a message to stdout when using the human output format,
# and print to stderr when using the json output format. Messages are
# also logged at the `info` level. For more information about logs, see
# [Logs](logs.md).
#
# > **Note:** Not available in apply block
Puppet::Functions.create_function(:'out::message') do
  # Output a message.
  # @param message The message to output.
  # @example Print a message
  #   out::message('Something went wrong')
  dispatch :output_message do
    param 'Any', :message
    return_type 'Undef'
  end

  def output_message(message)
    unless Puppet[:tasks]
      raise Puppet::ParseErrorWithIssue
        .from_issue_and_stack(Bolt::PAL::Issues::PLAN_OPERATION_NOT_SUPPORTED_WHEN_COMPILING, action: 'out::message')
    end

    Puppet.lookup(:bolt_executor).tap do |executor|
      executor.report_function_call(self.class.name)
      executor.publish_event(type: :message, message: Bolt::Util::Format.stringify(message), level: :info)
    end

    nil
  end
end

Version data entries

22 entries across 22 versions & 1 rubygems

Version	Path
bolt-3.15.0	bolt-modules/out/lib/puppet/functions/out/message.rb
bolt-3.14.1	bolt-modules/out/lib/puppet/functions/out/message.rb