Spec-Zone.ru › Homebrew

Модуль: GitHub::Actions

Определён в:
utils/github/actions.rb

Обзор

Этот модуль является частью внутреннего API. Этот модуль можно использовать только внутри репозиториев, принадлежащих Homebrew, за исключением casks и формул. По возможности сторонним разработчикам следует избегать использования этого модуля, поскольку он может быть удалён или изменён без предупреждения.

Вспомогательные функции для взаимодействия с GitHub Actions.

Определено в пространстве имён

Классы: Annotation

Краткое описание методов класса свернуть

  • .env_set? ⇒ Boolean закрытый
  • .escape(string) ⇒ String закрытый
  • .puts_annotation_if_env_set!(type, message, file: nil, line: nil) ⇒ Boolean закрытый

Подробное описание методов класса

.env_set? ⇒ Boolean

Этот метод является частью закрытого API. Этот метод можно использовать только в репозитории Homebrew/brew. По возможности сторонним разработчикам следует избегать использования этого метода, поскольку он может быть удалён или изменён без предупреждения.

Возвращает:

  • (Boolean)


18
19
20
# File 'utils/github/actions.rb', line 18

def self.env_set?
  ENV.fetch("GITHUB_ACTIONS", false).present?
end

.escape(string) ⇒ String

Этот метод является частью закрытого API. Этот метод можно использовать только в репозитории Homebrew/brew. По возможности сторонним разработчикам следует избегать использования этого метода, поскольку он может быть удалён или изменён без предупреждения.

Параметры:

  • string (String)

Возвращает:

  • (String)


10
11
12
13
14
15
# File 'utils/github/actions.rb', line 10

def self.escape(string)
  # See https://github.community/t/set-output-truncates-multiline-strings/16852/3.
  string.gsub("%", "%25")
        .gsub("\n", "%0A")
        .gsub("\r", "%0D")
end

.puts_annotation_if_env_set!(type, message, file: nil, line: nil) ⇒ Boolean

Этот метод является частью закрытого API. Этот метод можно использовать только в репозитории Homebrew/brew. По возможности сторонним разработчикам следует избегать использования этого метода, поскольку он может быть удалён или изменён без предупреждения.

Параметры:

  • type (Symbol)
  • message (String)
  • file (String, Pathname, nil) (по умолчанию: nil)
  • line (Integer, nil) (по умолчанию: nil)

Возвращает:

  • (Boolean)


29
30
31
32
33
34
35
36
37
38
# File 'utils/github/actions.rb', line 29

def self.puts_annotation_if_env_set!(type, message, file: nil, line: nil)
  # Don't print annotations during tests, too messy to handle these.
  return false if ENV.fetch("HOMEBREW_TESTS", false)
  return false unless env_set?

  std = (type == :notice) ? $stdout : $stderr
  std.puts Annotation.new(type, message)

  true
end

© 2009–present Homebrew contributors
Licensed under the BSD 2-Clause License.
https://docs.brew.sh/rubydoc/GitHub/Actions.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API