Update satellite action docs

This commit is contained in:
Riyad Preukschas 2012-10-26 02:50:24 +02:00
parent 7192f86ed0
commit 904615c150
2 changed files with 9 additions and 4 deletions

View file

@ -1,9 +1,6 @@
module Gitlab module Gitlab
module Satellite module Satellite
# GitLab file editor # GitLab server-side file update and commit
#
# It gives you ability to make changes to files
# & commit this changes from GitLab UI.
class EditFileAction < Action class EditFileAction < Action
attr_accessor :file_path, :ref attr_accessor :file_path, :ref
@ -13,6 +10,12 @@ module Gitlab
@ref = ref @ref = ref
end end
# Updates the files content and creates a new commit for it
#
# Returns false if the ref has been updated while editing the file
# Returns false if commiting the change fails
# Returns false if pushing from the satellite to Gitolite failed or was rejected
# Returns true otherwise
def commit!(content, commit_message, last_commit) def commit!(content, commit_message, last_commit)
return false unless can_edit?(last_commit) return false unless can_edit?(last_commit)

View file

@ -1,5 +1,6 @@
module Gitlab module Gitlab
module Satellite module Satellite
# GitLab server-side merge
class MergeAction < Action class MergeAction < Action
attr_accessor :merge_request attr_accessor :merge_request
@ -8,6 +9,7 @@ module Gitlab
@merge_request = merge_request @merge_request = merge_request
end end
# Checks if a merge request can be executed without user interaction
def can_be_merged? def can_be_merged?
in_locked_and_timed_satellite do |merge_repo| in_locked_and_timed_satellite do |merge_repo|
merge_in_satellite!(merge_repo) merge_in_satellite!(merge_repo)