Skip to content

G
gitlab-ce
Commit 4beaf464 authored by Simon Knox's avatar Simon Knox
Browse files
Options

Merge branch '202144-automatically-add-default-issue-lists-for-issue-boards' into 'master' 

Automate todo and doing board columns

See merge request gitlab-org/gitlab!42038
parents ecefdd6e 54617af5
Hide whitespace changes
Inline Side-by-side
Showing with 19 additions and 284 deletions
app/assets/javascripts/boards/components/board_blank_state.vue deleted 100644 → 0
View file @ ecefdd6e
<script>
import { GlButton } from '@gitlab/ui';
import Cookies from 'js-cookie';
import { __ } from '~/locale';
import ListLabel from '~/boards/models/label';
import boardsStore from '../stores/boards_store';
export default {
components: {
GlButton,
},
data() {
return {
predefinedLabels: [
new ListLabel({ title: __('To Do'), color: '#F0AD4E' }),
new ListLabel({ title: __('Doing'), color: '#5CB85C' }),
],
};
},
methods: {
addDefaultLists() {
this.clearBlankState();
this.predefinedLabels.forEach((label, i) => {
boardsStore.addList({
title: label.title,
position: i,
list_type: 'label',
label: {
title: label.title,
color: label.color,
},
});
});
const loadListIssues = listObj => {
const list = boardsStore.findList('title', listObj.title);
if (!list) {
return null;
}
list.id = listObj.id;
list.label.id = listObj.label.id;
return list.getIssues().catch(() => {
// TODO: handle request error
});
};
// Save the labels
boardsStore
.generateDefaultLists()
.then(res => res.data)
.then(data => Promise.all(data.map(loadListIssues)))
.catch(() => {
boardsStore.removeList(undefined, 'label');
Cookies.remove('issue_board_welcome_hidden', {
path: '',
});
boardsStore.addBlankState();
});
},
clearBlankState: boardsStore.removeBlankState.bind(boardsStore),
},
};
</script>
<template>
<div class="board-blank-state p-3">
<p>
{{
s__('BoardBlankState|Add the following default lists to your Issue Board with one click:')
}}
</p>
<ul class="list-unstyled board-blank-state-list">
<li v-for="(label, index) in predefinedLabels" :key="index">
<span
:style="{ backgroundColor: label.color }"
class="label-color position-relative d-inline-block rounded"
></span>
{{ label.title }}
</li>
</ul>
<p>
{{
s__(
'BoardBlankState|Starting out with the default set of lists will get you right on the way to making the most of your board.',
)
}}
</p>
<gl-button
category="secondary"
variant="success"
block="block"
class="gl-mb-0"
@click.stop="addDefaultLists"
>
{{ s__('BoardBlankState|Add default lists') }}
</gl-button>
<gl-button category="secondary" variant="default" block="block" @click.stop="clearBlankState">
{{ s__("BoardBlankState|Nevermind, I'll use my own") }}
</gl-button>
</div>
</template>
app/assets/javascripts/boards/components/board_column.vue
View file @ 4beaf464
......@@ -6,7 +6,6 @@ import BoardListHeader from 'ee_else_ce/boards/components/board_list_header.vue'
import Tooltip from '~/vue_shared/directives/tooltip';
import EmptyComponent from '~/vue_shared/components/empty_component';
import glFeatureFlagMixin from '~/vue_shared/mixins/gl_feature_flags_mixin';
import BoardBlankState from './board_blank_state.vue';
import BoardList from './board_list.vue';
import boardsStore from '../stores/boards_store';
import eventHub from '../eventhub';
......@@ -16,7 +15,6 @@ import { ListType } from '../constants';
export default {
components: {
BoardPromotionState: EmptyComponent,
BoardBlankState,
BoardListHeader,
BoardList,
},
......@@ -54,7 +52,7 @@ export default {
computed: {
...mapGetters(['getIssues']),
showBoardListAndBoardInfo() {
return this.list.type !== ListType.blank && this.list.type !== ListType.promotion;
return this.list.type !== ListType.promotion;
},
uniqueKey() {
// eslint-disable-next-line @gitlab/require-i18n-strings
......@@ -148,7 +146,6 @@ export default {
:list="list"
:loading="list.loading"
/>
<board-blank-state v-if="canAdminList && list.id === 'blank'" />
<!-- Will be only available in EE -->
<board-promotion-state v-if="list.id === 'promotion'" />
......
app/assets/javascripts/boards/stores/boards_store.js
View file @ 4beaf464
......@@ -13,7 +13,6 @@ import {
convertObjectPropsToCamelCase,
} from '~/lib/utils/common_utils';
import createDefaultClient from '~/lib/graphql';
import { __ } from '~/locale';
import axios from '~/lib/utils/axios_utils';
import { mergeUrlParams } from '~/lib/utils/url_utility';
import { getIdFromGraphQLId } from '~/graphql_shared/utils';
......@@ -119,7 +118,6 @@ const boardsStore = {
.catch(() => {
// https://gitlab.com/gitlab-org/gitlab-foss/issues/30821
});
this.removeBlankState();
},
updateNewListDropdown(listId) {
$(`.js-board-list-${listId}`).removeClass('is-active');
......@@ -129,22 +127,14 @@ const boardsStore = {
return !this.state.lists.filter(list => list.type !== 'backlog' && list.type !== 'closed')[0];
},
addBlankState() {
if (!this.shouldAddBlankState() || this.welcomeIsHidden() || this.disabled) return;
if (!this.shouldAddBlankState() || this.welcomeIsHidden()) return;
this.addList({
id: 'blank',
list_type: 'blank',
title: __('Welcome to your Issue Board!'),
position: 0,
});
},
removeBlankState() {
this.removeList('blank');
Cookies.set('issue_board_welcome_hidden', 'true', {
expires: 365 * 10,
path: '',
});
this.generateDefaultLists()
.then(res => res.data)
.then(data => Promise.all(data.map(list => this.addList(list))))
.catch(() => {
this.removeList(undefined, 'label');
});
},
findIssueLabel(issue, findLabel) {
......
doc/user/project/issue_board.md
View file @ 4beaf464
......@@ -374,27 +374,22 @@ If you're not able to do some of the things above, make sure you have the right
### First time using an issue board
The first time you open an issue board, you are presented with
the default lists (**Open** and **Closed**) and a welcome message that gives
you two options. You can either:
> The automatic creation of the **To Do** and **Doing** lists was [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/202144) in GitLab 13.4.
- Create a predefined set of labels (by default: **To Do** and **Doing**) and create their
corresponding lists to the issue board.
- Opt-out and use your own lists.
The first time you open an issue board, you are presented with the default lists
(**Open**, **To Do**, **Doing**, and **Closed**).
![issue board welcome message](img/issue_board_welcome_message.png)
If the **To Do** and **Doing** labels don't exist in the project or group, they are created, and
their lists appear as empty. If any of them already exists, the list is filled with the issues that
have that label.
If you choose to use and create the predefined lists, they will appear as empty
because the labels associated to them will not exist up until that moment,
which means the system has no way of populating them automatically. That's of
course if the predefined labels don't already exist. If any of them does exist,
the list will be created and filled with the issues that have that label.
![issue board default lists](img/issue_board_default_lists_v13_4.png)
### Create a new list
Create a new list by clicking the **Add list** button in the upper right corner of the issue board.
![issue board welcome message](img/issue_board_add_list.png)
![creating a new list in an issue board](img/issue_board_add_list.png)
Then, choose the label or user to create the list from. The new list will be inserted
at the end of the lists, before **Done**. Moving and reordering lists is as
......
ee/spec/features/boards/scoped_issue_board_spec.rb
View file @ 4beaf464
......@@ -245,7 +245,7 @@ RSpec.describe 'Scoped issue boards', :js do
find('.board-card', match: :first)
expect(page).to have_selector('.board', count: 3)
expect(page).to have_selector('.board', count: 4)
expect(all('.board').first).to have_selector('.board-card', count: 2)
expect(all('.board').last).to have_selector('.board-card', count: 1)
end
......
locale/gitlab.pot
View file @ 4beaf464
......@@ -4087,18 +4087,6 @@ msgstr ""
msgid "Board scope affects which issues are displayed for anyone who visits this board"
msgstr ""
msgid "BoardBlankState|Add default lists"
msgstr ""
msgid "BoardBlankState|Add the following default lists to your Issue Board with one click:"
msgstr ""
msgid "BoardBlankState|Nevermind, I'll use my own"
msgstr ""
msgid "BoardBlankState|Starting out with the default set of lists will get you right on the way to making the most of your board."
msgstr ""
msgid "Boards"
msgstr ""
......@@ -9135,9 +9123,6 @@ msgstr ""
msgid "Documents reindexed: %{processed_documents} (%{percentage}%%)"
msgstr ""
msgid "Doing"
msgstr ""
msgid "Domain"
msgstr ""
......@@ -28782,9 +28767,6 @@ msgstr ""
msgid "Welcome to the guided GitLab tour"
msgstr ""
msgid "Welcome to your Issue Board!"
msgstr ""
msgid "Welcome to your issue board!"
msgstr ""
......
spec/features/boards/boards_spec.rb
View file @ 4beaf464
......@@ -24,33 +24,11 @@ RSpec.describe 'Issue Boards', :js do
context 'no lists' do
before do
visit project_board_path(project, board)
wait_for_requests
expect(page).to have_selector('.board', count: 3)
end
it 'shows blank state' do
expect(page).to have_content('Welcome to your Issue Board!')
end
it 'shows tooltip on add issues button' do
button = page.find('.filter-dropdown-container button', text: 'Add issues')
expect(button[:"data-original-title"]).to eq("Please add a list to your board first")
end
it 'hides the blank state when clicking nevermind button' do
page.within(find('.board-blank-state')) do
click_button("Nevermind, I'll use my own")
end
expect(page).to have_selector('.board', count: 2)
end
it 'creates default lists' do
lists = ['Open', 'To Do', 'Doing', 'Closed']
page.within(find('.board-blank-state')) do
click_button('Add default lists')
end
wait_for_requests
expect(page).to have_selector('.board', count: 4)
......
spec/frontend/boards/board_blank_state_spec.js deleted 100644 → 0
View file @ ecefdd6e
import Vue from 'vue';
import boardsStore from '~/boards/stores/boards_store';
import BoardBlankState from '~/boards/components/board_blank_state.vue';
describe('Boards blank state', () => {
let vm;
let fail = false;
beforeEach(done => {
const Comp = Vue.extend(BoardBlankState);
boardsStore.create();
jest.spyOn(boardsStore, 'addList').mockImplementation();
jest.spyOn(boardsStore, 'removeList').mockImplementation();
jest.spyOn(boardsStore, 'generateDefaultLists').mockImplementation(
() =>
new Promise((resolve, reject) => {
if (fail) {
reject();
} else {
resolve({
data: [
{
id: 1,
title: 'To Do',
label: { id: 1 },
},
{
id: 2,
title: 'Doing',
label: { id: 2 },
},
],
});
}
}),
);
vm = new Comp();
setImmediate(() => {
vm.$mount();
done();
});
});
it('renders pre-defined labels', () => {
expect(vm.$el.querySelectorAll('.board-blank-state-list li').length).toBe(2);
expect(vm.$el.querySelectorAll('.board-blank-state-list li')[0].textContent.trim()).toEqual(
'To Do',
);
expect(vm.$el.querySelectorAll('.board-blank-state-list li')[1].textContent.trim()).toEqual(
'Doing',
);
});
it('clears blank state', done => {
vm.$el.querySelector('.btn-default').click();
setImmediate(() => {
expect(boardsStore.welcomeIsHidden()).toBeTruthy();
done();
});
});
it('creates pre-defined labels', done => {
vm.$el.querySelector('.btn-success').click();
setImmediate(() => {
expect(boardsStore.addList).toHaveBeenCalledTimes(2);
expect(boardsStore.addList).toHaveBeenCalledWith(expect.objectContaining({ title: 'To Do' }));
expect(boardsStore.addList).toHaveBeenCalledWith(expect.objectContaining({ title: 'Doing' }));
done();
});
});
it('resets the store if request fails', done => {
fail = true;
vm.$el.querySelector('.btn-success').click();
setImmediate(() => {
expect(boardsStore.welcomeIsHidden()).toBeFalsy();
expect(boardsStore.removeList).toHaveBeenCalledWith(undefined, 'label');
done();
});
});
});
spec/frontend/boards/boards_store_spec.js
View file @ 4beaf464
......@@ -745,14 +745,6 @@ describe('boardsStore', () => {
expect(boardsStore.shouldAddBlankState()).toBe(true);
});
it('adds the blank state', () => {
boardsStore.addBlankState();
const list = boardsStore.findList('type', 'blank', 'blank');
expect(list).toBeDefined();
});
it('removes list from state', () => {
boardsStore.addList(listObj);
......
spec/support/shared_examples/boards/multiple_issue_boards_shared_examples.rb
View file @ 4beaf464
......@@ -85,7 +85,7 @@ RSpec.shared_examples 'multiple issue boards' do
wait_for_requests
expect(page).to have_selector('.board', count: 3)
expect(page).to have_selector('.board', count: 5)
in_boards_switcher_dropdown do
click_link board.name
......@@ -93,7 +93,7 @@ RSpec.shared_examples 'multiple issue boards' do
wait_for_requests
expect(page).to have_selector('.board', count: 2)
expect(page).to have_selector('.board', count: 4)
end
it 'maintains sidebar state over board switch' do
......
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
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7