Merge branch '27880-clearing-release-note-from-the-tags-page-deletes-release' into 'master'

27880 Make release notes optional and do not delete release when they are removed

See merge request gitlab-org/gitlab!26231

app/controllers/projects/tags/releases_controller.rb

@@ -12,11 +12,7 @@ class Projects::Tags::ReleasesController < Projects::ApplicationController
   end
 
   def update
-    if release_params[:description].present?
-      release.update(release_params)
-    else
-      release.destroy
-    end
+    release.update(release_params) if release.persisted? || release_params[:description].present?
 
     redirect_to project_tag_path(@project, tag.name)
   end

app/models/release.rb

@@ -24,7 +24,7 @@ class Release < ApplicationRecord
 
   accepts_nested_attributes_for :links, allow_destroy: true
 
-  validates :description, :project, :tag, presence: true
+  validates :project, :tag, presence: true
   validates_associated :milestone_releases, message: -> (_, obj) { obj[:value].map(&:errors).map(&:full_messages).join(",") }
 
   scope :sorted, -> { order(released_at: :desc) }

changelogs/unreleased/27880-clearing-release-note-from-the-tags-page-deletes-release.yml

+---
+title: 27880 Make release notes optional and do not delete release when they are removed
+merge_request: 26231
+author: Pavlo Dudchenko
+type: changed

doc/api/releases/index.md

@@ -328,7 +328,7 @@ POST /projects/:id/releases
 | `id`               | integer/string  | yes                         | The ID or [URL-encoded path of the project](../README.md#namespaced-path-encoding).                                              |
 | `name`             | string          | no                          | The release name.                                                                                                                |
 | `tag_name`         | string          | yes                         | The tag where the release will be created from.                                                                                  |
-| `description`      | string          | yes                         | The description of the release. You can use [Markdown](../../user/markdown.md).                                                  |
+| `description`      | string          | no                          | The description of the release. You can use [Markdown](../../user/markdown.md).                                                  |
 | `ref`              | string          | yes, if `tag_name` doesn't exist | If `tag_name` doesn't exist, the release will be created from `ref`. It can be a commit SHA, another tag name, or a branch name. |
 | `milestones`       | array of string | no                          | The title of each milestone the release is associated with.                                                                      |
 | `assets:links`     | array of hash   | no                          | An array of assets links.                                                                                                        |

lib/api/releases.rb

@@ -46,7 +46,7 @@ module API
       params do
         requires :tag_name,    type: String, desc: 'The name of the tag', as: :tag
         optional :name,        type: String, desc: 'The name of the release'
-        requires :description, type: String, desc: 'The release notes'
+        optional :description, type: String, desc: 'The release notes'
         optional :ref,         type: String, desc: 'The commit sha or branch name'
         optional :assets, type: Hash do
           optional :links, type: Array do

spec/controllers/projects/tags/releases_controller_spec.rb

@@ -67,13 +67,13 @@ describe Projects::Tags::ReleasesController do
       expect(response).to have_gitlab_http_status(:found)
     end
 
-    it 'deletes release when description is empty' do
-      initial_releases_count = project.releases.count
+    it 'does not delete release when description is empty' do
+      expect do
+        update_release(tag, "")
+      end.not_to change { project.releases.count }
 
-      response = update_release(release.tag, "")
+      expect(release.reload.description).to eq("")
 
-      expect(initial_releases_count).to eq(1)
-      expect(project.releases.count).to eq(0)
       expect(response).to have_gitlab_http_status(:found)
     end
 

spec/lib/gitlab/legacy_github_import/importer_spec.rb

@@ -173,10 +173,6 @@ describe Gitlab::LegacyGithubImport::Importer do
         ]
       }
 
-      unless project.gitea_import?
-        error[:errors] << { type: :release, url: "#{api_root}/repos/octocat/Hello-World/releases/2", errors: "Validation failed: Description can't be blank" }
-      end
-
       described_class.new(project).execute
 
       expect(project.import_state.last_error).to eq error.to_json

spec/models/release_spec.rb

@@ -20,7 +20,6 @@ RSpec.describe Release do
 
   describe 'validation' do
     it { is_expected.to validate_presence_of(:project) }
-    it { is_expected.to validate_presence_of(:description) }
     it { is_expected.to validate_presence_of(:tag) }
 
     context 'when a release exists in the database without a name' do

spec/requests/api/releases_spec.rb

@@ -406,6 +406,22 @@ describe API::Releases do
       expect(project.releases.last.description).to eq('Super nice release')
     end
 
+    it 'creates a new release without description' do
+      params = {
+          name: 'New release without description',
+          tag_name: 'v0.1',
+          released_at: '2019-03-25 10:00:00'
+      }
+
+      expect do
+        post api("/projects/#{project.id}/releases", maintainer), params: params
+      end.to change { Release.count }.by(1)
+
+      expect(project.releases.last.name).to eq('New release without description')
+      expect(project.releases.last.tag).to eq('v0.1')
+      expect(project.releases.last.description).to eq(nil)
+    end
+
     it 'sets the released_at to the current time if the released_at parameter is not provided' do
       now = Time.zone.parse('2015-08-25 06:00:00Z')
       Timecop.freeze(now) do
@@ -451,26 +467,6 @@ describe API::Releases do
       expect(project.releases.last.released_at).to eq('2019-03-25T01:00:00Z')
     end
 
-    context 'when description is empty' do
-      let(:params) do
-        {
-          name: 'New release',
-          tag_name: 'v0.1',
-          description: ''
-        }
-      end
-
-      it 'returns an error as validation failure' do
-        expect do
-          post api("/projects/#{project.id}/releases", maintainer), params: params
-        end.not_to change { Release.count }
-
-        expect(response).to have_gitlab_http_status(:bad_request)
-        expect(json_response['message'])
-          .to eq("Validation failed: Description can't be blank")
-      end
-    end
-
     it 'matches response schema' do
       post api("/projects/#{project.id}/releases", maintainer), params: params
 

spec/services/releases/update_service_spec.rb

@@ -44,12 +44,6 @@ describe Releases::UpdateService do
       it_behaves_like 'a failed update'
     end
 
-    context 'with an invalid update' do
-      let(:new_description) { '' }
-
-      it_behaves_like 'a failed update'
-    end
-
     context 'when a milestone is passed in' do
       let(:milestone) { create(:milestone, project: project, title: 'v1.0') }
       let(:params_with_milestone) { params.merge!({ milestones: [new_title] }) }