Class: Changelogger::RepoInfo

Inherits:

Struct

• Object
• Struct
• Changelogger::RepoInfo

Defined in:

lib/changelogger/repo_info.rb

Overview

Changelogger::RepoInfo holds metadata about the current repository.

Instance Attribute Summary

• #branch ⇒ String

  HEAD branch or “(detached)”.

• #dirty ⇒ Boolean

  True if there are uncommitted changes.

• #head_short ⇒ String

  Abbreviated HEAD sha.

• #name ⇒ String

  Repo name (directory name).

• #path ⇒ String

  Absolute repo root path.

• #remote ⇒ String

  Remote.origin.url (may be empty).

• #remote_slug ⇒ String^?

  “owner/repo” for GitHub remotes, otherwise nil.

Instance Attribute Details

#branch ⇒ String

Returns HEAD branch or “(detached)”.

Returns:

• (String) —

  HEAD branch or “(detached)”

# File 'lib/changelogger/repo_info.rb', line 20

RepoInfo = Struct.new(:name, :path, :branch, :head_short, :remote, :remote_slug, :dirty, keyword_init: true)

#dirty ⇒ Boolean

Returns true if there are uncommitted changes.

Returns:

• (Boolean) —

  true if there are uncommitted changes

# File 'lib/changelogger/repo_info.rb', line 20

RepoInfo = Struct.new(:name, :path, :branch, :head_short, :remote, :remote_slug, :dirty, keyword_init: true)

#head_short ⇒ String

Returns abbreviated HEAD sha.

Returns:

• (String) —

  abbreviated HEAD sha

# File 'lib/changelogger/repo_info.rb', line 20

RepoInfo = Struct.new(:name, :path, :branch, :head_short, :remote, :remote_slug, :dirty, keyword_init: true)

#name ⇒ String

Returns repo name (directory name).

Returns:

• (String) —

  repo name (directory name)

# File 'lib/changelogger/repo_info.rb', line 20

RepoInfo = Struct.new(:name, :path, :branch, :head_short, :remote, :remote_slug, :dirty, keyword_init: true)

#path ⇒ String

Returns absolute repo root path.

Returns:

• (String) —

  absolute repo root path

# File 'lib/changelogger/repo_info.rb', line 20

RepoInfo = Struct.new(:name, :path, :branch, :head_short, :remote, :remote_slug, :dirty, keyword_init: true)

#remote ⇒ String

Returns remote.origin.url (may be empty).

Returns:

• (String) —

  remote.origin.url (may be empty)

# File 'lib/changelogger/repo_info.rb', line 20

RepoInfo = Struct.new(:name, :path, :branch, :head_short, :remote, :remote_slug, :dirty, keyword_init: true)

#remote_slug ⇒ String^?

Returns “owner/repo” for GitHub remotes, otherwise nil.

Returns:

• (String, nil) —

  “owner/repo” for GitHub remotes, otherwise nil

# File 'lib/changelogger/repo_info.rb', line 20

RepoInfo = Struct.new(:name, :path, :branch, :head_short, :remote, :remote_slug, :dirty, keyword_init: true)