Merge pull request #433 from wordpress-mobile/add/create_release_improvements

Add is_draft parameter to create_release_action

Author: rynaardb

CHANGELOG.md

@@ -10,7 +10,7 @@ _None_
 
 ### New Features
 
-_None_
+- Add a `is_draft` parameter to the `create_release` action to specify whether the release should be created as a draft. [#433]
 
 ### Bug Fixes
 

lib/fastlane/plugin/wpmreleasetoolkit/actions/common/create_release_action.rb

@@ -14,6 +14,7 @@ def self.run(params)
         # Replace full URLS to PRs/Issues with shorthand, because GitHub does not render them properly otherwise.
         release_notes.gsub!(%r{https://github.com/([^/]*/[^/]*)/(pulls?|issues?)/([0-9]*)}, '\1#\3')
         prerelease = params[:prerelease]
+        is_draft = params[:is_draft]
 
         UI.message("Creating draft release #{version} in #{repository}.")
         # Verify assets
@@ -28,7 +29,8 @@ def self.run(params)
           target: params[:target],
           description: release_notes,
           assets: assets,
-          prerelease: prerelease
+          prerelease: prerelease,
+          is_draft: is_draft
         )
         UI.message('Done')
       end
@@ -83,6 +85,12 @@ def self.available_options
                                        optional: true,
                                        default_value: false,
                                        is_string: false),
+          FastlaneCore::ConfigItem.new(key: :is_draft,
+                                       env_name: 'GHHELPER_CREATE_RELEASE_IS_DRAFT',
+                                       description: 'True to create the GitHub release as a draft (instead of publishing it immediately)',
+                                       optional: true,
+                                       default_value: true,
+                                       type: Boolean),
           Fastlane::Helper::GithubHelper.github_token_config_item,
         ]
       end

lib/fastlane/plugin/wpmreleasetoolkit/helper/github_helper.rb

@@ -119,15 +119,16 @@ def create_milestone(repository:, title:, due_date:, days_until_submission:, day
       # @param [String] description The text to use as the release's body / description (typically the release notes)
       # @param [Array<String>] assets List of file paths to attach as assets to the release
       # @param [TrueClass|FalseClass] prerelease Indicates if this should be created as a pre-release (i.e. for alpha/beta)
+      # @param [TrueClass|FalseClass] is_draft Indicates if this should be created as a draft release
       #
-      def create_release(repository:, version:, target: nil, description:, assets:, prerelease:)
+      def create_release(repository:, version:, target: nil, description:, assets:, prerelease:, is_draft:)
         release = client.create_release(
           repository,
           version, # tag name
           name: version, # release name
           target_commitish: target || Git.open(Dir.pwd).log.first.sha,
-          draft: true,
           prerelease: prerelease,
+          draft: is_draft,
           body: description
         )
         assets.each do |file_path|

spec/github_helper_spec.rb

@@ -398,7 +398,7 @@ def create_milestone(due_date:, days_until_submission:, days_until_release:)
     it 'has the correct options' do
       options = { body: test_description, draft: true, name: test_tag, prerelease: false, target_commitish: test_target }
       expect(client).to receive(:create_release).with(test_repo, test_tag, options)
-      create_release
+      create_release(is_draft: true)
     end
 
     it 'uploads the assets to the correct location' do
@@ -407,18 +407,31 @@ def create_milestone(due_date:, days_until_submission:, days_until_release:)
 
       allow(client).to receive(:create_release).and_return({ url: test_url })
       expect(client).to receive(:upload_asset).with(test_url, test_assets, { content_type: 'application/octet-stream' })
-      create_release(assets: [test_assets])
+      create_release(is_draft: true, assets: [test_assets])
     end
 
-    def create_release(assets: [])
+    it 'creates a draft release if is_draft is set to true' do
+      options_draft_release = { body: test_description, draft: true, name: test_tag, prerelease: false, target_commitish: test_target }
+      expect(client).to receive(:create_release).with(test_repo, test_tag, options_draft_release)
+      create_release(is_draft: true)
+    end
+
+    it 'creates a final (non-draft) release if is_draft is set to false' do
+      options_final_release = { body: test_description, draft: false, name: test_tag, prerelease: false, target_commitish: test_target }
+      expect(client).to receive(:create_release).with(test_repo, test_tag, options_final_release)
+      create_release(is_draft: false)
+    end
+
+    def create_release(is_draft:, assets: [])
       helper = described_class.new(github_token: 'Fake-GitHubToken-123')
       helper.create_release(
         repository: test_repo,
         version: test_tag,
         target: test_target,
         description: test_description,
         assets: assets,
-        prerelease: false
+        prerelease: false,
+        is_draft: is_draft
       )
     end
   end