class R10K::Environment::Git
This class implements an environment based on a Git branch.
@since 1.3.0
Attributes
@!attribute [r] ref
@return [String] The git reference to use for this environment
@!attribute [r] remote
@return [String] The URL to the remote git repository
@!attribute [r] repo
@api private @return [R10K::Git::StatefulRepository] The git repo backing this environment
Public Class Methods
Initialize the given SVN environment.
@param name [String] The unique name describing this environment. @param basedir [String] The base directory where this environment will be created. @param dirname [String] The directory name for this environment. @param options [Hash] An additional set of options for this environment.
@param options [String] :remote The URL to the remote git repository @param options [String] :ref The git reference to use for this environment
# File lib/r10k/environment/git.rb, line 35 def initialize(name, basedir, dirname, options = {}) super @remote = options[:remote] @ref = options[:ref] @repo = R10K::Git::StatefulRepository.new(@ref, @remote, @basedir, @dirname) end
Public Instance Methods
Return a sting which uniquely identifies (per source) the current state of the environment.
@api public @return [String]
# File lib/r10k/environment/git.rb, line 60 def signature @repo.head end
Clone or update the given Git environment.
If the environment is being created for the first time, it will automatically update all modules to ensure that the environment is complete.
@api public @return [void]
# File lib/r10k/environment/git.rb, line 50 def sync @repo.sync @synced = true end