Class: Fastlane::Actions::GitlabReleaseCloseAction

Inherits:
Action
  • Object
show all
Defined in:
lib/fastlane/plugin/gitlab_release/actions/gitlab_release_close.rb

Class Method Summary collapse

Class Method Details

.authors ⇒ Object 



44
45
46
 
# File 'lib/fastlane/plugin/gitlab_release/actions/gitlab_release_close.rb', line 44

def self.authors
  ["Andrea Del Fante"]
end

.available_options ⇒ Object 



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/fastlane/plugin/gitlab_release/actions/gitlab_release_close.rb', line 48

def self.available_options
  [
    FastlaneCore::ConfigItem.new(key: :endpoint,
                                 env_name: "GITLAB_API_ENDPOINT",
                                 description: "The API endpoint URL, default: ENV['GITLAB_API_ENDPOINT'] and falls back to ENV['CI_API_V4_URL']",
                                 optional: true,
                                 type: String),
    FastlaneCore::ConfigItem.new(key: :private_token,
                                 env_name: "GITLAB_API_PRIVATE_TOKEN",
                                 description: "User's private token or OAuth2 access token",
                                 optional: true,
                                 type: String),
    FastlaneCore::ConfigItem.new(key: :version_name,
                                 description: "The name of the version. (ex: 1.0)",
                                 optional: false,
                                 type: String),
    FastlaneCore::ConfigItem.new(key: :entries,
                                 description: "The generated changelog to include",
                                 optional: false,
                                 type: Gitlab::Release::Changelog::Entries),
    FastlaneCore::ConfigItem.new(key: :tag_name,
                                 description: "The name of the tag. (ex: 1.0). Default: version_name value",
                                 optional: true,
                                 type: String),
    FastlaneCore::ConfigItem.new(key: :project_id,
                                 env_name: "CI_PROJECT_ID",
                                 description: "The id of this project, given from GitLab. Default ENV[\"CI_PROJECT_ID\"]",
                                 optional: true,
                                 is_string: false,
                                 verify_block: proc do |value|
                                   case value
                                   when String, Integer
                                     @project_id = value
                                   else
                                     UI.user_error!("The project_id must be a String or Integer value")
                                   end
                                 end),
    FastlaneCore::ConfigItem.new(key: :ref,
                                 env_name: "CI_COMMIT_SHA",
                                 description: "The commit SHA. Default ENV[\"CI_COMMIT_SHA\"]",
                                 optional: true,
                                 type: String)
  ]
end

.description ⇒ Object 



36
37
38
 
# File 'lib/fastlane/plugin/gitlab_release/actions/gitlab_release_close.rb', line 36

def self.description
  "Create a tag with release note and close milestones"
end

.details ⇒ Object 



40
41
42
 
# File 'lib/fastlane/plugin/gitlab_release/actions/gitlab_release_close.rb', line 40

def self.details
  "This action create a tag containing release note and close the associated milestones"
end

.is_supported?(platform) ⇒ Boolean

Returns:

  • (Boolean) 


93
94
95
 
# File 'lib/fastlane/plugin/gitlab_release/actions/gitlab_release_close.rb', line 93

def self.is_supported?(platform)
  true
end

.run(params) ⇒ Object 



9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
 
# File 'lib/fastlane/plugin/gitlab_release/actions/gitlab_release_close.rb', line 9

def self.run(params)
  require 'gitlab/release/manager'

  endpoint = params[:endpoint]
  private_token = params[:private_token]
  version_name = params[:version_name]
  entries = params[:entries]
  tag_name = params[:tag_name] || version_name
  project_id = params[:project_id]
  ref = params[:ref]

  manager = Gitlab::Release::Manager.new(endpoint: endpoint,
                                         private_token: private_token)

  UI.message("Closing all milestones related to version '#{version_name}'")
  manager.close_milestones(version_name,
                           project_id: project_id)
  UI.success("All milestones related to version '#{version_name}' are closed now!")

  UI.message("Defining tag '#{tag_name}' in '#{ref}'")
  manager.define_tag(tag_name,
                     entries.to_s_with_reference,
                     project_id: project_id,
                     ref: ref)
  UI.success("Defined tag '#{tag_name}' with changelog successfully!")
end