Commit 4453104d authored by Rémy Coutable's avatar Rémy Coutable

Merge branch '2460-3690-support-multiline-tag-message' into 'master'

Support multi-line tag messages

_Originally opened at !2853 by @clns._

- - -

Tag messages in Git can include a short summary of what changes are included in a release and any other relevant information. So I think GitLab should support multi-line tag messages, both in the "New Tag" interface and when viewing the tag.

Also a non-technical user could use GitLab's interface to create releases, but at the moment this is impossible because he cannot enter a multi-line message. This would've been very handy, otherwise he would need to do it from the command line or other GUI program, which is not something a non-technical user has access to or knows how to do.

This merge request adds support for multi-line tag messages. Below are the impacted screens. Let me know if I should change anything.

This would close #3690 and #2460

![image](/uploads/d33bede1141bfb10c5d9c301ee1cb0ec/image.png)
![image](/uploads/ebfea358c1a5986e7b95ad31748f7a6a/image.png)

See merge request !3833
parents 3af78b5c 1026f2ad
...@@ -22,6 +22,7 @@ v 8.8.0 (unreleased) ...@@ -22,6 +22,7 @@ v 8.8.0 (unreleased)
- Updated search UI - Updated search UI
- Display informative message when new milestone is created - Display informative message when new milestone is created
- Sanitize milestones and labels titles - Sanitize milestones and labels titles
- Support multi-line tag messages. !3833 (Calin Seciu)
- Allow "NEWS" and "CHANGES" as alternative names for CHANGELOG. !3768 (Connor Shea) - Allow "NEWS" and "CHANGES" as alternative names for CHANGELOG. !3768 (Connor Shea)
- Added button to toggle whitespaces changes on diff view - Added button to toggle whitespaces changes on diff view
- Backport GitHub Enterprise import support from EE - Backport GitHub Enterprise import support from EE
......
...@@ -23,7 +23,7 @@ ...@@ -23,7 +23,7 @@
.form-group .form-group
= label_tag :message, nil, class: 'control-label' = label_tag :message, nil, class: 'control-label'
.col-sm-10 .col-sm-10
= text_field_tag :message, nil, required: false, tabindex: 3, class: 'form-control' = text_area_tag :message, nil, required: false, tabindex: 3, class: 'form-control', rows: 5
.help-block Optionally, enter a message to create an annotated tag. .help-block Optionally, enter a message to create an annotated tag.
%hr %hr
.form-group .form-group
......
...@@ -19,15 +19,13 @@ ...@@ -19,15 +19,13 @@
%i.fa.fa-trash-o %i.fa.fa-trash-o
.title .title
%span.item-title= @tag.name %span.item-title= @tag.name
- if @tag.message.present?
%span.light
 
= strip_gpg_signature(@tag.message)
- if @commit - if @commit
= render 'projects/branches/commit', commit: @commit, project: @project = render 'projects/branches/commit', commit: @commit, project: @project
- else - else
Cant find HEAD commit for this tag Cant find HEAD commit for this tag
- if @tag.message.present?
%pre.body
= strip_gpg_signature(@tag.message)
.append-bottom-default.prepend-top-default .append-bottom-default.prepend-top-default
- if @release.description.present? - if @release.description.present?
......
@project_commits
Feature: Project Commits Tags
Background:
Given I sign in as a user
And I own project "Shop"
Given I visit project tags page
Scenario: I can see all git tags
Then I should see "Shop" all tags list
Scenario: I create a tag
And I click new tag link
And I submit new tag form
Then I should see new tag created
Scenario: I create a tag with release notes
Given I click new tag link
And I submit new tag form with release notes
Then I should see new tag created
And I should see tag release notes
Scenario: I create a tag with invalid name
And I click new tag link
And I submit new tag form with invalid name
Then I should see new an error that tag is invalid
Scenario: I create a tag with invalid reference
And I click new tag link
And I submit new tag form with invalid reference
Then I should see new an error that tag ref is invalid
Scenario: I create a tag that already exists
And I click new tag link
And I submit new tag form with tag that already exists
Then I should see new an error that tag already exists
Scenario: I delete a tag
Given I visit tag 'v1.1.0' page
Given I delete tag 'v1.1.0'
Then I should not see tag 'v1.1.0'
Scenario: I add release notes to the tag
Given I visit tag 'v1.1.0' page
When I click edit tag link
And I fill release notes and submit form
Then I should see tag release notes
class Spinach::Features::ProjectCommitsTags < Spinach::FeatureSteps
include SharedAuthentication
include SharedProject
include SharedPaths
step 'I should see "Shop" all tags list' do
expect(page).to have_content "Tags"
expect(page).to have_content "v1.0.0"
end
step 'I click new tag link' do
click_link 'New tag'
end
step 'I submit new tag form' do
fill_in 'tag_name', with: 'v7.0'
fill_in 'ref', with: 'master'
click_button 'Create tag'
end
step 'I submit new tag form with release notes' do
fill_in 'tag_name', with: 'v7.0'
fill_in 'ref', with: 'master'
fill_in 'release_description', with: 'Awesome release notes'
click_button 'Create tag'
end
step 'I fill release notes and submit form' do
fill_in 'release_description', with: 'Awesome release notes'
click_button 'Save changes'
end
step 'I submit new tag form with invalid name' do
fill_in 'tag_name', with: 'v 1.0'
fill_in 'ref', with: 'master'
click_button 'Create tag'
end
step 'I submit new tag form with invalid reference' do
fill_in 'tag_name', with: 'foo'
fill_in 'ref', with: 'foo'
click_button 'Create tag'
end
step 'I submit new tag form with tag that already exists' do
fill_in 'tag_name', with: 'v1.0.0'
fill_in 'ref', with: 'master'
click_button 'Create tag'
end
step 'I should see new tag created' do
expect(page).to have_content 'v7.0'
end
step 'I should see new an error that tag is invalid' do
expect(page).to have_content 'Tag name invalid'
end
step 'I should see new an error that tag ref is invalid' do
expect(page).to have_content 'Target foo is invalid'
end
step 'I should see new an error that tag already exists' do
expect(page).to have_content 'Tag v1.0.0 already exists'
end
step "I visit tag 'v1.1.0' page" do
click_link 'v1.1.0'
end
step "I delete tag 'v1.1.0'" do
page.within('.content') do
first('.btn-remove').click
end
end
step "I should not see tag 'v1.1.0'" do
page.within '.tags' do
expect(page).not_to have_link 'v1.1.0'
end
end
step 'I click edit tag link' do
click_link 'Edit release notes'
end
step 'I should see tag release notes' do
expect(page).to have_content 'Awesome release notes'
end
end
require 'spec_helper'
feature 'Master creates tag', feature: true do
let(:user) { create(:user) }
let(:project) { create(:project, namespace: user.namespace) }
before do
project.team << [user, :master]
login_with(user)
visit namespace_project_tags_path(project.namespace, project)
end
scenario 'with an invalid name displays an error' do
create_tag_in_form(tag: 'v 1.0', ref: 'master')
expect(page).to have_content 'Tag name invalid'
end
scenario 'with an invalid reference displays an error' do
create_tag_in_form(tag: 'v2.0', ref: 'foo')
expect(page).to have_content 'Target foo is invalid'
end
scenario 'that already exists displays an error' do
create_tag_in_form(tag: 'v1.1.0', ref: 'master')
expect(page).to have_content 'Tag v1.1.0 already exists'
end
scenario 'with multiline message displays the message in a <pre> block' do
create_tag_in_form(tag: 'v3.0', ref: 'master', message: "Awesome tag message\n\n- hello\n- world")
expect(current_path).to eq(
namespace_project_tag_path(project.namespace, project, 'v3.0'))
expect(page).to have_content 'v3.0'
page.within 'pre.body' do
expect(page).to have_content "Awesome tag message\n\n- hello\n- world"
end
end
scenario 'with multiline release notes parses the release note as Markdown' do
create_tag_in_form(tag: 'v4.0', ref: 'master', desc: "Awesome release notes\n\n- hello\n- world")
expect(current_path).to eq(
namespace_project_tag_path(project.namespace, project, 'v4.0'))
expect(page).to have_content 'v4.0'
page.within '.description' do
expect(page).to have_content 'Awesome release notes'
expect(page).to have_selector('ul li', count: 2)
end
end
def create_tag_in_form(tag:, ref:, message: nil, desc: nil)
click_link 'New tag'
fill_in 'tag_name', with: tag
fill_in 'ref', with: ref
fill_in 'message', with: message unless message.nil?
fill_in 'release_description', with: desc unless desc.nil?
click_button 'Create tag'
end
end
require 'spec_helper'
feature 'Master deletes tag', feature: true do
let(:user) { create(:user) }
let(:project) { create(:project, namespace: user.namespace) }
before do
project.team << [user, :master]
login_with(user)
visit namespace_project_tags_path(project.namespace, project)
end
context 'from the tags list page' do
scenario 'deletes the tag' do
expect(page).to have_content 'v1.1.0'
page.within('.content') do
first('.btn-remove').click
end
expect(current_path).to eq(
namespace_project_tags_path(project.namespace, project))
expect(page).not_to have_content 'v1.1.0'
end
end
context 'from a specific tag page' do
scenario 'deletes the tag' do
click_on 'v1.0.0'
expect(current_path).to eq(
namespace_project_tag_path(project.namespace, project, 'v1.0.0'))
click_on 'Delete tag'
expect(current_path).to eq(
namespace_project_tags_path(project.namespace, project))
expect(page).not_to have_content 'v1.0.0'
end
end
end
require 'spec_helper'
feature 'Master updates tag', feature: true do
let(:user) { create(:user) }
let(:project) { create(:project, namespace: user.namespace) }
before do
project.team << [user, :master]
login_with(user)
visit namespace_project_tags_path(project.namespace, project)
end
context 'from the tags list page' do
scenario 'updates the release notes' do
page.within(first('.controls')) do
click_link 'Edit release notes'
end
fill_in 'release_description', with: 'Awesome release notes'
click_button 'Save changes'
expect(current_path).to eq(
namespace_project_tag_path(project.namespace, project, 'v1.1.0'))
expect(page).to have_content 'v1.1.0'
expect(page).to have_content 'Awesome release notes'
end
end
context 'from a specific tag page' do
scenario 'updates the release notes' do
click_on 'v1.1.0'
click_link 'Edit release notes'
fill_in 'release_description', with: 'Awesome release notes'
click_button 'Save changes'
expect(current_path).to eq(
namespace_project_tag_path(project.namespace, project, 'v1.1.0'))
expect(page).to have_content 'v1.1.0'
expect(page).to have_content 'Awesome release notes'
end
end
end
require 'spec_helper'
feature 'Master views tags', feature: true do
let(:user) { create(:user) }
before do
project.team << [user, :master]
login_with(user)
end
context 'when project has no tags' do
let(:project) { create(:project_empty_repo) }
before do
visit namespace_project_path(project.namespace, project)
click_on 'README'
fill_in :commit_message, with: 'Add a README file', visible: true
# Remove pre-receive hook so we can push without auth
FileUtils.rm_f(File.join(project.repository.path, 'hooks', 'pre-receive'))
click_button 'Commit Changes'
visit namespace_project_tags_path(project.namespace, project)
end
scenario 'displays a specific message' do
expect(page).to have_content 'Repository has no tags yet.'
end
end
context 'when project has tags' do
let(:project) { create(:project, namespace: user.namespace) }
before do
visit namespace_project_tags_path(project.namespace, project)
end
scenario 'views the tags list page' do
expect(page).to have_content 'v1.0.0'
end
scenario 'views a specific tag page' do
click_on 'v1.0.0'
expect(current_path).to eq(
namespace_project_tag_path(project.namespace, project, 'v1.0.0'))
expect(page).to have_content 'v1.0.0'
expect(page).to have_content 'This tag has no release notes.'
end
describe 'links on the tag page' do
scenario 'has a button to browse files' do
click_on 'v1.0.0'
expect(current_path).to eq(
namespace_project_tag_path(project.namespace, project, 'v1.0.0'))
click_on 'Browse files'
expect(current_path).to eq(
namespace_project_tree_path(project.namespace, project, 'v1.0.0'))
end
scenario 'has a button to browse commits' do
click_on 'v1.0.0'
expect(current_path).to eq(
namespace_project_tag_path(project.namespace, project, 'v1.0.0'))
click_on 'Browse commits'
expect(current_path).to eq(
namespace_project_commits_path(project.namespace, project, 'v1.0.0'))
end
end
end
end
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment