Module: Gitlab::CI::CLI::Helpers

Extended by:
Helpers
Includes:
Gitlab::CLI::Helpers
Included in:
Gitlab::CI::CLI, Helpers, Help
Defined in:
lib/gitlab/ci/cli_helpers.rb

Overview

Defines methods related to CLI output and formatting.

Instance Method Summary collapse

Instance Method Details

#actions ⇒ Array

Returns actions available to CLI & Shell

Returns:

  • (Array) 


16
17
18
 
# File 'lib/gitlab/ci/cli_helpers.rb', line 16

def actions
  @actions ||= Gitlab::CI.actions
end

#client ⇒ Gitlab::Client

Returns Gitlab::Client instance

Returns:

  • (Gitlab::Client) 


23
24
25
 
# File 'lib/gitlab/ci/cli_helpers.rb', line 23

def client
  @client ||= Gitlab::CI::Client.new(endpoint: (Gitlab.endpoint || ''))
end

#help(cmd = nil, &block) ⇒ String

Gets defined help for a specific command/action.

Returns:

  • (String) 


38
39
40
41
42
43
44
 
# File 'lib/gitlab/ci/cli_helpers.rb', line 38

def help(cmd=nil, &block)
  if cmd.nil? || Gitlab::CI::Help.help_map.key?(cmd)
    Gitlab::CI::Help.actions_table(cmd)
  else
    Gitlab::CI::Help.get_help(cmd, &block)
  end
end

#valid_command?(cmd) ⇒ Boolean

Confirms command is valid.

Returns:

  • (Boolean) 


30
31
32
33
 
# File 'lib/gitlab/ci/cli_helpers.rb', line 30

def valid_command?(cmd)
  command = cmd.is_a?(Symbol) ? cmd : cmd.to_sym
  Gitlab::CI.actions.include?(command)
end