Skip to content

G
gitlab-ce
Commit 20a9ab33 authored by Marcin Sedlak-Jakubowski's avatar Marcin Sedlak-Jakubowski Committed by Marcel Amirault
Browse files
Options

Revert "Remove "introduced in" 8.x and earlier" 

This reverts commit 020af2c3b331e6f8815ba67df853fa315a0fd68d.
parent 0ec581bc
Show whitespace changes
Inline Side-by-side
Showing with 103 additions and 131 deletions
doc/api/epics.md
View file @ 20a9ab33
...@@ -12,7 +12,7 @@ The [epic issues API](epic_issues.md) allows you to interact with issues associa ...@@ -12,7 +12,7 @@ The [epic issues API](epic_issues.md) allows you to interact with issues associa
## Milestone dates integration ## Milestone dates integration
> [Introduced][ee-6448] in GitLab 11.3. > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/6448) in GitLab 11.3.
Since start date and due date can be dynamically sourced from related issue milestones, when user has edit permission, Since start date and due date can be dynamically sourced from related issue milestones, when user has edit permission,
additional fields will be shown. These include two boolean fields `start_date_is_fixed` and `due_date_is_fixed`, additional fields will be shown. These include two boolean fields `start_date_is_fixed` and `due_date_is_fixed`,
...@@ -224,7 +224,7 @@ Example response: ...@@ -224,7 +224,7 @@ Example response:
Creates a new epic. Creates a new epic.
NOTE: **Note:** NOTE: **Note:**
Starting with GitLab [11.3][ee-6448], `start_date` and `end_date` should no longer be assigned Starting with GitLab [11.3](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/6448), `start_date` and `end_date` should no longer be assigned
directly, as they now represent composite values. You can configure it via the `*_is_fixed` and directly, as they now represent composite values. You can configure it via the `*_is_fixed` and
`*_fixed` fields instead. `*_fixed` fields instead.
...@@ -298,7 +298,7 @@ Example response: ...@@ -298,7 +298,7 @@ Example response:
Updates an epic. Updates an epic.
NOTE: **Note:** NOTE: **Note:**
Starting with GitLab [11.3][ee-6448], `start_date` and `end_date` should no longer be assigned Starting with GitLab [11.3](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/6448), `start_date` and `end_date` should no longer be assigned
directly, as they now represent composite values. You can configure it via the `*_is_fixed` and directly, as they now represent composite values. You can configure it via the `*_is_fixed` and
`*_fixed` fields instead. `*_fixed` fields instead.
...@@ -460,5 +460,3 @@ Example response: ...@@ -460,5 +460,3 @@ Example response:
"created_at": "2016-07-01T11:09:13.992Z" "created_at": "2016-07-01T11:09:13.992Z"
} }
``` ```
[ee-6448]: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/6448
doc/api/group_level_variables.md
View file @ 20a9ab33
# Group-level Variables API # Group-level Variables API
> [Introduced][ce-34519] in GitLab 9.5 > [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/issues/34519) in GitLab 9.5
## List group variables ## List group variables
...@@ -142,5 +142,3 @@ DELETE /groups/:id/variables/:key ...@@ -142,5 +142,3 @@ DELETE /groups/:id/variables/:key
```shell ```shell
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/1/variables/VARIABLE_1" curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/1/variables/VARIABLE_1"
``` ```
[ce-34519]: https://gitlab.com/gitlab-org/gitlab-foss/issues/34519
doc/api/issues.md
View file @ 20a9ab33
...@@ -49,12 +49,12 @@ GET /issues?confidential=true ...@@ -49,12 +49,12 @@ GET /issues?confidential=true
| `labels` | string | no | Comma-separated list of label names, issues must have all labels to be returned. `None` lists all issues with no labels. `Any` lists all issues with at least one label. `No+Label` (Deprecated) lists all issues with no labels. Predefined names are case-insensitive. | | `labels` | string | no | Comma-separated list of label names, issues must have all labels to be returned. `None` lists all issues with no labels. `Any` lists all issues with at least one label. `No+Label` (Deprecated) lists all issues with no labels. Predefined names are case-insensitive. |
| `with_labels_details` | boolean | no | If `true`, response will return more details for each label in labels field: `:name`, `:color`, `:description`, `:description_html`, `:text_color`. Default is `false`. The `description_html` attribute was introduced in [GitLab 12.7](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/21413)| | `with_labels_details` | boolean | no | If `true`, response will return more details for each label in labels field: `:name`, `:color`, `:description`, `:description_html`, `:text_color`. Default is `false`. The `description_html` attribute was introduced in [GitLab 12.7](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/21413)|
| `milestone` | string | no | The milestone title. `None` lists all issues with no milestone. `Any` lists all issues that have an assigned milestone. | | `milestone` | string | no | The milestone title. `None` lists all issues with no milestone. `Any` lists all issues that have an assigned milestone. |
| `scope` | string | no | Return issues for the given scope: `created_by_me`, `assigned_to_me` or `all`. Defaults to `created_by_me`<br> For versions before 11.0, use the now deprecated `created-by-me` or `assigned-to-me` scopes instead.<br> _([Introduced][ce-13004] in GitLab 9.5. [Changed to snake_case][ce-18935] in GitLab 11.0)_ | | `scope` | string | no | Return issues for the given scope: `created_by_me`, `assigned_to_me` or `all`. Defaults to `created_by_me`<br> For versions before 11.0, use the now deprecated `created-by-me` or `assigned-to-me` scopes instead.<br> _([Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/13004) in GitLab 9.5. [Changed to snake_case](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/18935) in GitLab 11.0)_ |
| `author_id` | integer | no | Return issues created by the given user `id`. Mutually exclusive with `author_username`. Combine with `scope=all` or `scope=assigned_to_me`. _([Introduced][ce-13004] in GitLab 9.5)_ | | `author_id` | integer | no | Return issues created by the given user `id`. Mutually exclusive with `author_username`. Combine with `scope=all` or `scope=assigned_to_me`. _([Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/13004) in GitLab 9.5)_ |
| `author_username` | string | no | Return issues created by the given `username`. Similar to `author_id` and mutually exclusive with `author_id`. | | `author_username` | string | no | Return issues created by the given `username`. Similar to `author_id` and mutually exclusive with `author_id`. |
| `assignee_id` | integer | no | Return issues assigned to the given user `id`. Mutually exclusive with `assignee_username`. `None` returns unassigned issues. `Any` returns issues with an assignee. _([Introduced][ce-13004] in GitLab 9.5)_ | | `assignee_id` | integer | no | Return issues assigned to the given user `id`. Mutually exclusive with `assignee_username`. `None` returns unassigned issues. `Any` returns issues with an assignee. _([Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/13004) in GitLab 9.5)_ |
| `assignee_username` | string array | no | Return issues assigned to the given `username`. Similar to `assignee_id` and mutually exclusive with `assignee_id`. In CE version `assignee_username` array should only contain a single value or an invalid parameter error will be returned otherwise. | | `assignee_username` | string array | no | Return issues assigned to the given `username`. Similar to `assignee_id` and mutually exclusive with `assignee_id`. In CE version `assignee_username` array should only contain a single value or an invalid parameter error will be returned otherwise. |
| `my_reaction_emoji` | string | no | Return issues reacted by the authenticated user by the given `emoji`. `None` returns issues not given a reaction. `Any` returns issues given at least one reaction. _([Introduced][ce-14016] in GitLab 10.0)_ | | `my_reaction_emoji` | string | no | Return issues reacted by the authenticated user by the given `emoji`. `None` returns issues not given a reaction. `Any` returns issues given at least one reaction. _([Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/14016) in GitLab 10.0)_ |
| `weight` **(STARTER)** | integer | no | Return issues with the specified `weight`. `None` returns issues with no weight assigned. `Any` returns issues with a weight assigned. | | `weight` **(STARTER)** | integer | no | Return issues with the specified `weight`. `None` returns issues with no weight assigned. `Any` returns issues with a weight assigned. |
| `iids[]` | integer array | no | Return only the issues having the given `iid` | | `iids[]` | integer array | no | Return only the issues having the given `iid` |
| `order_by` | string | no | Return issues ordered by `created_at`, `updated_at`, `priority`, `due_date`, `relative_position`, `label_priority`, `milestone_due`, `popularity`, `weight` fields. Default is `created_at` | | `order_by` | string | no | Return issues ordered by `created_at`, `updated_at`, `priority`, `due_date`, `relative_position`, `label_priority`, `milestone_due`, `popularity`, `weight` fields. Default is `created_at` |
...@@ -175,7 +175,7 @@ the `weight` parameter: ...@@ -175,7 +175,7 @@ the `weight` parameter:
**Note**: `assignee` column is deprecated, now we show it as a single-sized array `assignees` to conform to the GitLab EE API. **Note**: `assignee` column is deprecated, now we show it as a single-sized array `assignees` to conform to the GitLab EE API.
**Note**: The `closed_by` attribute was [introduced in GitLab 10.6][ce-17042]. This value will only be present for issues which were closed after GitLab 10.6 and when the user account that closed the issue still exists. **Note**: The `closed_by` attribute was [introduced in GitLab 10.6](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/17042). This value will only be present for issues which were closed after GitLab 10.6 and when the user account that closed the issue still exists.
## List group issues ## List group issues
...@@ -206,12 +206,12 @@ GET /groups/:id/issues?confidential=true ...@@ -206,12 +206,12 @@ GET /groups/:id/issues?confidential=true
| `with_labels_details` | boolean | no | If `true`, response will return more details for each label in labels field: `:name`, `:color`, `:description`, `:description_html`, `:text_color`. Default is `false`. The `description_html` attribute was introduced in [GitLab 12.7](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/21413) | | `with_labels_details` | boolean | no | If `true`, response will return more details for each label in labels field: `:name`, `:color`, `:description`, `:description_html`, `:text_color`. Default is `false`. The `description_html` attribute was introduced in [GitLab 12.7](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/21413) |
| `iids[]` | integer array | no | Return only the issues having the given `iid` | | `iids[]` | integer array | no | Return only the issues having the given `iid` |
| `milestone` | string | no | The milestone title. `None` lists all issues with no milestone. `Any` lists all issues that have an assigned milestone. | | `milestone` | string | no | The milestone title. `None` lists all issues with no milestone. `Any` lists all issues that have an assigned milestone. |
| `scope` | string | no | Return issues for the given scope: `created_by_me`, `assigned_to_me` or `all`.<br> For versions before 11.0, use the now deprecated `created-by-me` or `assigned-to-me` scopes instead.<br> _([Introduced][ce-13004] in GitLab 9.5. [Changed to snake_case][ce-18935] in GitLab 11.0)_ | | `scope` | string | no | Return issues for the given scope: `created_by_me`, `assigned_to_me` or `all`.<br> For versions before 11.0, use the now deprecated `created-by-me` or `assigned-to-me` scopes instead.<br> _([Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/13004) in GitLab 9.5. [Changed to snake_case](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/18935) in GitLab 11.0)_ |
| `author_id` | integer | no | Return issues created by the given user `id`. Mutually exclusive with `author_username`. Combine with `scope=all` or `scope=assigned_to_me`. _([Introduced][ce-13004] in GitLab 9.5)_ | | `author_id` | integer | no | Return issues created by the given user `id`. Mutually exclusive with `author_username`. Combine with `scope=all` or `scope=assigned_to_me`. _([Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/13004) in GitLab 9.5)_ |
| `author_username` | string | no | Return issues created by the given `username`. Similar to `author_id` and mutually exclusive with `author_id`. | | `author_username` | string | no | Return issues created by the given `username`. Similar to `author_id` and mutually exclusive with `author_id`. |
| `assignee_id` | integer | no | Return issues assigned to the given user `id`. Mutually exclusive with `assignee_username`. `None` returns unassigned issues. `Any` returns issues with an assignee. _([Introduced][ce-13004] in GitLab 9.5)_ | | `assignee_id` | integer | no | Return issues assigned to the given user `id`. Mutually exclusive with `assignee_username`. `None` returns unassigned issues. `Any` returns issues with an assignee. _([Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/13004) in GitLab 9.5)_ |
| `assignee_username` | string array | no | Return issues assigned to the given `username`. Similar to `assignee_id` and mutually exclusive with `assignee_id`. In CE version `assignee_username` array should only contain a single value or an invalid parameter error will be returned otherwise. | | `assignee_username` | string array | no | Return issues assigned to the given `username`. Similar to `assignee_id` and mutually exclusive with `assignee_id`. In CE version `assignee_username` array should only contain a single value or an invalid parameter error will be returned otherwise. |
| `my_reaction_emoji` | string | no | Return issues reacted by the authenticated user by the given `emoji`. `None` returns issues not given a reaction. `Any` returns issues given at least one reaction. _([Introduced][ce-14016] in GitLab 10.0)_ | | `my_reaction_emoji` | string | no | Return issues reacted by the authenticated user by the given `emoji`. `None` returns issues not given a reaction. `Any` returns issues given at least one reaction. _([Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/14016) in GitLab 10.0)_ |
| `weight` **(STARTER)** | integer | no | Return issues with the specified `weight`. `None` returns issues with no weight assigned. `Any` returns issues with a weight assigned. | | `weight` **(STARTER)** | integer | no | Return issues with the specified `weight`. `None` returns issues with no weight assigned. `Any` returns issues with a weight assigned. |
| `order_by` | string | no | Return issues ordered by `created_at`, `updated_at`, `priority`, `due_date`, `relative_position`, `label_priority`, `milestone_due`, `popularity`, `weight` fields. Default is `created_at` | | `order_by` | string | no | Return issues ordered by `created_at`, `updated_at`, `priority`, `due_date`, `relative_position`, `label_priority`, `milestone_due`, `popularity`, `weight` fields. Default is `created_at` |
| `sort` | string | no | Return issues sorted in `asc` or `desc` order. Default is `desc` | | `sort` | string | no | Return issues sorted in `asc` or `desc` order. Default is `desc` |
...@@ -330,7 +330,7 @@ the `weight` parameter: ...@@ -330,7 +330,7 @@ the `weight` parameter:
**Note**: `assignee` column is deprecated, now we show it as a single-sized array `assignees` to conform to the GitLab EE API. **Note**: `assignee` column is deprecated, now we show it as a single-sized array `assignees` to conform to the GitLab EE API.
**Note**: The `closed_by` attribute was [introduced in GitLab 10.6][ce-17042]. This value will only be present for issues which were closed after GitLab 10.6 and when the user account that closed the issue still exists. **Note**: The `closed_by` attribute was [introduced in GitLab 10.6](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/17042). This value will only be present for issues which were closed after GitLab 10.6 and when the user account that closed the issue still exists.
## List project issues ## List project issues
...@@ -361,12 +361,12 @@ GET /projects/:id/issues?confidential=true ...@@ -361,12 +361,12 @@ GET /projects/:id/issues?confidential=true
| `labels` | string | no | Comma-separated list of label names, issues must have all labels to be returned. `None` lists all issues with no labels. `Any` lists all issues with at least one label. `No+Label` (Deprecated) lists all issues with no labels. Predefined names are case-insensitive. | | `labels` | string | no | Comma-separated list of label names, issues must have all labels to be returned. `None` lists all issues with no labels. `Any` lists all issues with at least one label. `No+Label` (Deprecated) lists all issues with no labels. Predefined names are case-insensitive. |
| `with_labels_details` | boolean | no | If `true`, response will return more details for each label in labels field: `:name`, `:color`, `:description`, `:description_html`, `:text_color`. Default is `false`. `description_html` Introduced in [GitLab 12.7](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/21413) | | `with_labels_details` | boolean | no | If `true`, response will return more details for each label in labels field: `:name`, `:color`, `:description`, `:description_html`, `:text_color`. Default is `false`. `description_html` Introduced in [GitLab 12.7](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/21413) |
| `milestone` | string | no | The milestone title. `None` lists all issues with no milestone. `Any` lists all issues that have an assigned milestone. | | `milestone` | string | no | The milestone title. `None` lists all issues with no milestone. `Any` lists all issues that have an assigned milestone. |
| `scope` | string | no | Return issues for the given scope: `created_by_me`, `assigned_to_me` or `all`.<br> For versions before 11.0, use the now deprecated `created-by-me` or `assigned-to-me` scopes instead.<br> _([Introduced][ce-13004] in GitLab 9.5. [Changed to snake_case][ce-18935] in GitLab 11.0)_ | | `scope` | string | no | Return issues for the given scope: `created_by_me`, `assigned_to_me` or `all`.<br> For versions before 11.0, use the now deprecated `created-by-me` or `assigned-to-me` scopes instead.<br> _([Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/13004) in GitLab 9.5. [Changed to snake_case](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/18935) in GitLab 11.0)_ |
| `author_id` | integer | no | Return issues created by the given user `id`. Mutually exclusive with `author_username`. Combine with `scope=all` or `scope=assigned_to_me`. _([Introduced][ce-13004] in GitLab 9.5)_ | | `author_id` | integer | no | Return issues created by the given user `id`. Mutually exclusive with `author_username`. Combine with `scope=all` or `scope=assigned_to_me`. _([Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/13004) in GitLab 9.5)_ |
| `author_username` | string | no | Return issues created by the given `username`. Similar to `author_id` and mutually exclusive with `author_id`. | | `author_username` | string | no | Return issues created by the given `username`. Similar to `author_id` and mutually exclusive with `author_id`. |
| `assignee_id` | integer | no | Return issues assigned to the given user `id`. Mutually exclusive with `assignee_username`. `None` returns unassigned issues. `Any` returns issues with an assignee. _([Introduced][ce-13004] in GitLab 9.5)_ | | `assignee_id` | integer | no | Return issues assigned to the given user `id`. Mutually exclusive with `assignee_username`. `None` returns unassigned issues. `Any` returns issues with an assignee. _([Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/13004) in GitLab 9.5)_ |
| `assignee_username` | string array | no | Return issues assigned to the given `username`. Similar to `assignee_id` and mutually exclusive with `assignee_id`. In CE version `assignee_username` array should only contain a single value or an invalid parameter error will be returned otherwise. | | `assignee_username` | string array | no | Return issues assigned to the given `username`. Similar to `assignee_id` and mutually exclusive with `assignee_id`. In CE version `assignee_username` array should only contain a single value or an invalid parameter error will be returned otherwise. |
| `my_reaction_emoji` | string | no | Return issues reacted by the authenticated user by the given `emoji`. `None` returns issues not given a reaction. `Any` returns issues given at least one reaction. _([Introduced][ce-14016] in GitLab 10.0)_ | | `my_reaction_emoji` | string | no | Return issues reacted by the authenticated user by the given `emoji`. `None` returns issues not given a reaction. `Any` returns issues given at least one reaction. _([Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/14016) in GitLab 10.0)_ |
| `weight` **(STARTER)** | integer | no | Return issues with the specified `weight`. `None` returns issues with no weight assigned. `Any` returns issues with a weight assigned. | | `weight` **(STARTER)** | integer | no | Return issues with the specified `weight`. `None` returns issues with no weight assigned. `Any` returns issues with a weight assigned. |
| `order_by` | string | no | Return issues ordered by `created_at`, `updated_at`, `priority`, `due_date`, `relative_position`, `label_priority`, `milestone_due`, `popularity`, `weight` fields. Default is `created_at` | | `order_by` | string | no | Return issues ordered by `created_at`, `updated_at`, `priority`, `due_date`, `relative_position`, `label_priority`, `milestone_due`, `popularity`, `weight` fields. Default is `created_at` |
| `sort` | string | no | Return issues sorted in `asc` or `desc` order. Default is `desc` | | `sort` | string | no | Return issues sorted in `asc` or `desc` order. Default is `desc` |
...@@ -491,7 +491,7 @@ the `weight` parameter: ...@@ -491,7 +491,7 @@ the `weight` parameter:
**Note**: `assignee` column is deprecated, now we show it as a single-sized array `assignees` to conform to the GitLab EE API. **Note**: `assignee` column is deprecated, now we show it as a single-sized array `assignees` to conform to the GitLab EE API.
**Note**: The `closed_by` attribute was [introduced in GitLab 10.6][ce-17042]. This value will only be present for issues which were closed after GitLab 10.6 and when the user account that closed the issue still exists. **Note**: The `closed_by` attribute was [introduced in GitLab 10.6](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/17042). This value will only be present for issues which were closed after GitLab 10.6 and when the user account that closed the issue still exists.
## Single issue ## Single issue
...@@ -628,7 +628,7 @@ the `epic` property: ...@@ -628,7 +628,7 @@ the `epic` property:
**Note**: `assignee` column is deprecated, now we show it as a single-sized array `assignees` to conform to the GitLab EE API. **Note**: `assignee` column is deprecated, now we show it as a single-sized array `assignees` to conform to the GitLab EE API.
**Note**: The `closed_by` attribute was [introduced in GitLab 10.6][ce-17042]. This value will only be present for issues which were closed after GitLab 10.6 and when the user account that closed the issue still exists. **Note**: The `closed_by` attribute was [introduced in GitLab 10.6](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/17042). This value will only be present for issues which were closed after GitLab 10.6 and when the user account that closed the issue still exists.
**Note**: The `epic_iid` attribute is deprecated and [will be removed in 13.0](https://gitlab.com/gitlab-org/gitlab/issues/35157). **Note**: The `epic_iid` attribute is deprecated and [will be removed in 13.0](https://gitlab.com/gitlab-org/gitlab/issues/35157).
Please use `iid` of the `epic` attribute instead. Please use `iid` of the `epic` attribute instead.
...@@ -651,8 +651,8 @@ POST /projects/:id/issues ...@@ -651,8 +651,8 @@ POST /projects/:id/issues
| `assignee_ids` | integer array | no | The ID of a user to assign issue | | `assignee_ids` | integer array | no | The ID of a user to assign issue |
| `milestone_id` | integer | no | The global ID of a milestone to assign issue | | `milestone_id` | integer | no | The global ID of a milestone to assign issue |
| `labels` | string | no | Comma-separated label names for an issue | | `labels` | string | no | Comma-separated label names for an issue |
| `created_at` | string | no | Date time string, ISO 8601 formatted, e.g. `2016-03-11T03:45:40Z` (requires admin or project/group owner rights) | | `created_at` | string | no | Date time string, ISO 8601 formatted, for example `2016-03-11T03:45:40Z` (requires admin or project/group owner rights) |
| `due_date` | string | no | Date time string in the format YEAR-MONTH-DAY, e.g. `2016-03-11` | | `due_date` | string | no | Date time string in the format YEAR-MONTH-DAY, for example `2016-03-11` |
| `merge_request_to_resolve_discussions_of` | integer | no | The IID of a merge request in which to resolve all issues. This will fill the issue with a default description and mark all discussions as resolved. When passing a description or title, these values will take precedence over the default values.| | `merge_request_to_resolve_discussions_of` | integer | no | The IID of a merge request in which to resolve all issues. This will fill the issue with a default description and mark all discussions as resolved. When passing a description or title, these values will take precedence over the default values.|
| `discussion_to_resolve` | string | no | The ID of a discussion to resolve. This will fill in the issue with a default description and mark the discussion as resolved. Use in combination with `merge_request_to_resolve_discussions_of`. | | `discussion_to_resolve` | string | no | The ID of a discussion to resolve. This will fill in the issue with a default description and mark the discussion as resolved. Use in combination with `merge_request_to_resolve_discussions_of`. |
| `weight` **(STARTER)** | integer | no | The weight of the issue. Valid values are greater than or equal to 0. | | `weight` **(STARTER)** | integer | no | The weight of the issue. Valid values are greater than or equal to 0. |
...@@ -738,7 +738,7 @@ the `weight` parameter: ...@@ -738,7 +738,7 @@ the `weight` parameter:
**Note**: `assignee` column is deprecated, now we show it as a single-sized array `assignees` to conform to the GitLab EE API. **Note**: `assignee` column is deprecated, now we show it as a single-sized array `assignees` to conform to the GitLab EE API.
**Note**: The `closed_by` attribute was [introduced in GitLab 10.6][ce-17042]. This value will only be present for issues which were closed after GitLab 10.6 and when the user account that closed the issue still exists. **Note**: The `closed_by` attribute was [introduced in GitLab 10.6](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/17042). This value will only be present for issues which were closed after GitLab 10.6 and when the user account that closed the issue still exists.
## Edit issue ## Edit issue
...@@ -760,8 +760,8 @@ PUT /projects/:id/issues/:issue_iid ...@@ -760,8 +760,8 @@ PUT /projects/:id/issues/:issue_iid
| `milestone_id` | integer | no | The global ID of a milestone to assign the issue to. Set to `0` or provide an empty value to unassign a milestone.| | `milestone_id` | integer | no | The global ID of a milestone to assign the issue to. Set to `0` or provide an empty value to unassign a milestone.|
| `labels` | string | no | Comma-separated label names for an issue. Set to an empty string to unassign all labels. | | `labels` | string | no | Comma-separated label names for an issue. Set to an empty string to unassign all labels. |
| `state_event` | string | no | The state event of an issue. Set `close` to close the issue and `reopen` to reopen it | | `state_event` | string | no | The state event of an issue. Set `close` to close the issue and `reopen` to reopen it |
| `updated_at` | string | no | Date time string, ISO 8601 formatted, e.g. `2016-03-11T03:45:40Z` (requires admin or project owner rights). Empty string or null values are not accepted.| | `updated_at` | string | no | Date time string, ISO 8601 formatted, for example `2016-03-11T03:45:40Z` (requires admin or project owner rights). Empty string or null values are not accepted.|
| `due_date` | string | no | Date time string in the format YEAR-MONTH-DAY, e.g. `2016-03-11` | | `due_date` | string | no | Date time string in the format YEAR-MONTH-DAY, for example `2016-03-11` |
| `weight` **(STARTER)** | integer | no | The weight of the issue. Valid values are greater than or equal to 0. 0 | | `weight` **(STARTER)** | integer | no | The weight of the issue. Valid values are greater than or equal to 0. 0 |
| `discussion_locked` | boolean | no | Flag indicating if the issue's discussion is locked. If the discussion is locked only project members can add or edit comments. | | `discussion_locked` | boolean | no | Flag indicating if the issue's discussion is locked. If the discussion is locked only project members can add or edit comments. |
| `epic_id` **(ULTIMATE)** | integer | no | ID of the epic to add the issue to. Valid values are greater than or equal to 0. | | `epic_id` **(ULTIMATE)** | integer | no | ID of the epic to add the issue to. Valid values are greater than or equal to 0. |
...@@ -858,7 +858,7 @@ NOTE: **Note**: ...@@ -858,7 +858,7 @@ NOTE: **Note**:
`assignee` column is deprecated. We now show it as a single-sized array `assignees` to conform to the GitLab EE API. `assignee` column is deprecated. We now show it as a single-sized array `assignees` to conform to the GitLab EE API.
NOTE: **Note**: NOTE: **Note**:
The `closed_by` attribute was [introduced in GitLab 10.6][ce-17042]. This value will only be present for issues which were closed after GitLab 10.6 and when the user account that closed the issue still exists. The `closed_by` attribute was [introduced in GitLab 10.6](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/17042). This value will only be present for issues which were closed after GitLab 10.6 and when the user account that closed the issue still exists.
## Delete an issue ## Delete an issue
...@@ -985,7 +985,7 @@ the `weight` parameter: ...@@ -985,7 +985,7 @@ the `weight` parameter:
**Note**: `assignee` column is deprecated, now we show it as a single-sized array `assignees` to conform to the GitLab EE API. **Note**: `assignee` column is deprecated, now we show it as a single-sized array `assignees` to conform to the GitLab EE API.
**Note**: The `closed_by` attribute was [introduced in GitLab 10.6][ce-17042]. This value will only be present for issues which were closed after GitLab 10.6 and when the user account that closed the issue still exists. **Note**: The `closed_by` attribute was [introduced in GitLab 10.6](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/17042). This value will only be present for issues which were closed after GitLab 10.6 and when the user account that closed the issue still exists.
## Subscribe to an issue ## Subscribe to an issue
...@@ -1091,7 +1091,7 @@ the `weight` parameter: ...@@ -1091,7 +1091,7 @@ the `weight` parameter:
**Note**: `assignee` column is deprecated, now we show it as a single-sized array `assignees` to conform to the GitLab EE API. **Note**: `assignee` column is deprecated, now we show it as a single-sized array `assignees` to conform to the GitLab EE API.
**Note**: The `closed_by` attribute was [introduced in GitLab 10.6][ce-17042]. This value will only be present for issues which were closed after GitLab 10.6 and when the user account that closed the issue still exists. **Note**: The `closed_by` attribute was [introduced in GitLab 10.6](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/17042). This value will only be present for issues which were closed after GitLab 10.6 and when the user account that closed the issue still exists.
## Unsubscribe from an issue ## Unsubscribe from an issue
...@@ -1278,7 +1278,7 @@ Example response: ...@@ -1278,7 +1278,7 @@ Example response:
**Note**: `assignee` column is deprecated, now we show it as a single-sized array `assignees` to conform to the GitLab EE API. **Note**: `assignee` column is deprecated, now we show it as a single-sized array `assignees` to conform to the GitLab EE API.
**Note**: The `closed_by` attribute was [introduced in GitLab 10.6][ce-17042]. This value will only be present for issues which were closed after GitLab 10.6 and when the user account that closed the issue still exists. **Note**: The `closed_by` attribute was [introduced in GitLab 10.6](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/17042). This value will only be present for issues which were closed after GitLab 10.6 and when the user account that closed the issue still exists.
## Set a time estimate for an issue ## Set a time estimate for an issue
...@@ -1719,8 +1719,3 @@ Example response: ...@@ -1719,8 +1719,3 @@ Example response:
"akismet_submitted": false "akismet_submitted": false
} }
``` ```
[ce-13004]: https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/13004
[ce-14016]: https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/14016
[ce-17042]: https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/17042
[ce-18935]: https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/18935
doc/api/project_snippets.md
View file @ 20a9ab33
...@@ -183,7 +183,7 @@ curl https://gitlab.com/api/v4/projects/:id/snippets/:snippet_id/raw \ ...@@ -183,7 +183,7 @@ curl https://gitlab.com/api/v4/projects/:id/snippets/:snippet_id/raw \
## Get user agent details ## Get user agent details
> [Introduced][ce-29508] in GitLab 9.4. > [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/issues/29508) in GitLab 9.4.
Available only for admins. Available only for admins.
...@@ -211,5 +211,3 @@ Example response: ...@@ -211,5 +211,3 @@ Example response:
"akismet_submitted": false "akismet_submitted": false
} }
``` ```
[ce-29508]: https://gitlab.com/gitlab-org/gitlab-foss/issues/29508
doc/api/todos.md
View file @ 20a9ab33
# Todos API # Todos API
> [Introduced][ce-3188] in GitLab 8.10. > [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/3188) in GitLab 8.10.
## Get a list of todos ## Get a list of todos
...@@ -287,5 +287,3 @@ POST /todos/mark_as_done ...@@ -287,5 +287,3 @@ POST /todos/mark_as_done
```shell ```shell
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/todos/mark_as_done curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/todos/mark_as_done
``` ```
[ce-3188]: https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/3188
doc/user/discussions/index.md
View file @ 20a9ab33
...@@ -15,14 +15,14 @@ There are standard comments, and you also have the option to create a comment ...@@ -15,14 +15,14 @@ There are standard comments, and you also have the option to create a comment
in the form of a thread. A comment can also be [turned into a thread](#start-a-thread-by-replying-to-a-standard-comment) in the form of a thread. A comment can also be [turned into a thread](#start-a-thread-by-replying-to-a-standard-comment)
when it receives a reply. when it receives a reply.
The comment area supports [Markdown] and [quick actions]. You can edit your own The comment area supports [Markdown](../markdown.md) and [quick actions](../project/quick_actions.md). You can edit your own
comment at any time, and anyone with [Maintainer access level][permissions] or comment at any time, and anyone with [Maintainer access level](../permissions.md) or
higher can also edit a comment made by someone else. higher can also edit a comment made by someone else.
You can also reply to a comment notification email to reply to the comment if You can also reply to a comment notification email to reply to the comment if
[Reply by email] is configured for your GitLab instance. Replying to a standard comment [Reply by email] is configured for your GitLab instance. Replying to a standard comment
creates another standard comment. Replying to a threaded comment creates a reply in the thread. Email replies support creates another standard comment. Replying to a threaded comment creates a reply in the thread. Email replies support
[Markdown] and [quick actions], just as if you replied from the web. [Markdown](../markdown.md) and [quick actions](../project/quick_actions.md), just as if you replied from the web.
NOTE: **Note:** NOTE: **Note:**
There is a limit of 5,000 comments for every object, for example: issue, epic, and merge request. There is a limit of 5,000 comments for every object, for example: issue, epic, and merge request.
...@@ -48,7 +48,7 @@ to address feedback and lets you hide threads that are no longer relevant. ...@@ -48,7 +48,7 @@ to address feedback and lets you hide threads that are no longer relevant.
### Commit threads in the context of a merge request ### Commit threads in the context of a merge request
> [Introduced][ce-31847] in GitLab 10.3. > [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/issues/31847) in GitLab 10.3.
For reviewers with commit-based workflow, it may be useful to add threads to For reviewers with commit-based workflow, it may be useful to add threads to
specific commit diffs in the context of a merge request. These threads will specific commit diffs in the context of a merge request. These threads will
...@@ -112,7 +112,7 @@ Alternatively, you can mark each comment as resolved individually. ...@@ -112,7 +112,7 @@ Alternatively, you can mark each comment as resolved individually.
### Move all unresolved threads in a merge request to an issue ### Move all unresolved threads in a merge request to an issue
> [Introduced][ce-8266] in GitLab 9.1 > [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/8266) in GitLab 9.1
To continue all open threads from a merge request in a new issue, click the To continue all open threads from a merge request in a new issue, click the
**Resolve all threads in new issue** button. **Resolve all threads in new issue** button.
...@@ -156,7 +156,7 @@ add a note to the merge request thread referencing the new issue. ...@@ -156,7 +156,7 @@ add a note to the merge request thread referencing the new issue.
### Only allow merge requests to be merged if all threads are resolved ### Only allow merge requests to be merged if all threads are resolved
> [Introduced][ce-7125] in GitLab 8.14. > [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/7125) in GitLab 8.14.
You can prevent merge requests from being merged until all threads are You can prevent merge requests from being merged until all threads are
resolved. resolved.
...@@ -174,7 +174,7 @@ are resolved. ...@@ -174,7 +174,7 @@ are resolved.
### Automatically resolve merge request diff threads when they become outdated ### Automatically resolve merge request diff threads when they become outdated
> [Introduced][ce-14053] in GitLab 10.0. > [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/14053) in GitLab 10.0.
You can automatically resolve merge request diff threads on lines modified You can automatically resolve merge request diff threads on lines modified
with a new push. with a new push.
...@@ -200,7 +200,7 @@ force push. ...@@ -200,7 +200,7 @@ force push.
## Threaded discussions ## Threaded discussions
> [Introduced][ce-7527] in GitLab 9.1. > [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/7527) in GitLab 9.1.
While resolvable threads are only available to merge request diffs, While resolvable threads are only available to merge request diffs,
threads can also be added without a diff. You can start a specific threads can also be added without a diff. You can start a specific
...@@ -220,7 +220,7 @@ comments in greater detail. ...@@ -220,7 +220,7 @@ comments in greater detail.
## Image threads ## Image threads
> [Introduced][ce-14061] in GitLab 10.1. > [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/14061) in GitLab 10.1.
Sometimes a thread is revolved around an image. With image threads, Sometimes a thread is revolved around an image. With image threads,
you can easily target a specific coordinate of an image and start a thread you can easily target a specific coordinate of an image and start a thread
...@@ -257,7 +257,7 @@ load and will have a corresponding badge counter to match the counter on the ima ...@@ -257,7 +257,7 @@ load and will have a corresponding badge counter to match the counter on the ima
## Lock discussions ## Lock discussions
> [Introduced][ce-14531] in GitLab 10.1. > [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/14531) in GitLab 10.1.
For large projects with many contributors, it may be useful to stop threads For large projects with many contributors, it may be useful to stop threads
in issues or merge requests in these scenarios: in issues or merge requests in these scenarios:
...@@ -313,7 +313,7 @@ All comments that are part of a review show two buttons: ...@@ -313,7 +313,7 @@ All comments that are part of a review show two buttons:
![A comment that is part of a review](img/pending_review_comment.png) ![A comment that is part of a review](img/pending_review_comment.png)
You can use [quick actions] inside review comments. The comment will show the actions that will be performed once published. You can use [quick actions](../project/quick_actions.md) inside review comments. The comment will show the actions that will be performed once published.
![A review comment with quick actions](img/review_comment_quickactions.png) ![A review comment with quick actions](img/review_comment_quickactions.png)
...@@ -500,20 +500,3 @@ to the original comment, so a note about when it was last edited will appear und ...@@ -500,20 +500,3 @@ to the original comment, so a note about when it was last edited will appear und
This feature only exists for Issues, Merge requests, and Epics. Commits, Snippets and Merge request diff threads are This feature only exists for Issues, Merge requests, and Epics. Commits, Snippets and Merge request diff threads are
not supported yet. not supported yet.
[ce-7125]: https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/7125
[ce-7527]: https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/7527
[ce-7180]: https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/7180
[ce-8266]: https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/8266
[ce-14053]: https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/14053
[ce-14061]: https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/14061
[ce-14531]: https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/14531
[ce-31847]: https://gitlab.com/gitlab-org/gitlab-foss/issues/31847
[resolve-discussion-button]: img/resolve_discussion_button.png
[resolve-comment-button]: img/resolve_comment_button.png
[discussion-view]: img/discussion_view.png
[discussions-resolved]: img/discussions_resolved.png
[markdown]: ../markdown.md
[quick actions]: ../project/quick_actions.md
[permissions]: ../permissions.md
[Reply by email]: ../../administration/reply_by_email.md
doc/user/project/badges.md
View file @ 20a9ab33
...@@ -4,8 +4,9 @@ ...@@ -4,8 +4,9 @@
Badges are a unified way to present condensed pieces of information about your Badges are a unified way to present condensed pieces of information about your
projects. They consist of a small image and additionally a URL that the image projects. They consist of a small image and additionally a URL that the image
points to. Examples for badges can be the [pipeline status], [test coverage], points to. Examples for badges can be the [pipeline status](../../ci/pipelines/settings.md#pipeline-status-badge),
or ways to contact the project maintainers. [test coverage](../../ci/pipelines/settings.md#test-coverage-report-badge), or ways to contact the
project maintainers.
![Badges on Project overview page](img/project_overview_badges.png) ![Badges on Project overview page](img/project_overview_badges.png)
...@@ -73,6 +74,3 @@ using these placeholders if the information is sensitive. ...@@ -73,6 +74,3 @@ using these placeholders if the information is sensitive.
You can also configure badges via the GitLab API. As in the settings, there is You can also configure badges via the GitLab API. As in the settings, there is
a distinction between endpoints for badges on the a distinction between endpoints for badges on the
[project level](../../api/project_badges.md) and [group level](../../api/group_badges.md). [project level](../../api/project_badges.md) and [group level](../../api/group_badges.md).
[pipeline status]: ../../ci/pipelines/settings.md#pipeline-status-badge
[test coverage]: ../../ci/pipelines/settings.md#test-coverage-report-badge
doc/user/project/description_templates.md
View file @ 20a9ab33
# Description templates # Description templates
>[Introduced][ce-4981] in GitLab 8.11. >[Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/4981) in GitLab 8.11.
We all know that a properly submitted issue is more likely to be addressed in We all know that a properly submitted issue is more likely to be addressed in
a timely manner by the developers of a project. a timely manner by the developers of a project.
...@@ -27,12 +27,12 @@ templates of the default branch will be taken into account. ...@@ -27,12 +27,12 @@ templates of the default branch will be taken into account.
- Add a template to be used in every issue for a specific project, - Add a template to be used in every issue for a specific project,
giving instructions and guidelines, requiring for information specific to that subject. giving instructions and guidelines, requiring for information specific to that subject.
For example, if you have a project for tracking new blog posts, you can require the For example, if you have a project for tracking new blog posts, you can require the
title, outlines, author name, author social media information, etc. title, outlines, author name, author social media information, and so on.
- Following the previous example, you can make a template for every MR submitted - Following the previous example, you can make a template for every MR submitted
with a new blog post, requiring information about the post date, frontmatter data, with a new blog post, requiring information about the post date, frontmatter data,
images guidelines, link to the related issue, reviewer name, etc. images guidelines, link to the related issue, reviewer name, and so on.
- You can also create issues and merge request templates for different - You can also create issues and merge request templates for different
stages of your workflow, e.g., feature proposal, feature improvement, bug report, etc. stages of your workflow, for example, feature proposal, feature improvement, or a bug report.
## Creating issue templates ## Creating issue templates
...@@ -57,25 +57,25 @@ changes you made after picking the template and return it to its initial status. ...@@ -57,25 +57,25 @@ changes you made after picking the template and return it to its initial status.
## Setting a default template for merge requests and issues **(STARTER)** ## Setting a default template for merge requests and issues **(STARTER)**
> **Notes:** > - This feature was introduced before [description templates](#overview) and is available in [GitLab Starter](https://about.gitlab.com/pricing/). It can be enabled in the project's settings.
> > - Templates for issues were [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/28) in GitLab EE 8.1.
> - This feature was introduced before [description templates](#overview) and is > - Templates for merge requests were [introduced](https://gitlab.com/gitlab-org/gitlab/commit/7478ece8b48e80782b5465b96c79f85cc91d391b) in GitLab EE 6.9.
> available in [GitLab Starter][products]. It can be enabled
> in the project's settings.
> - Templates for issues were [introduced][ee-28] in GitLab EE 8.1.
> - Templates for merge requests were [introduced][ee-7478ece] in GitLab EE 6.9.
The visibility of issues and/or merge requests should be set to either "Everyone The visibility of issues and/or merge requests should be set to either "Everyone
with access" or "Only Project Members" in your project's **Settings / Visibility, project features, permissions** section, otherwise the with access" or "Only Project Members" in your project's **Settings / Visibility, project features, permissions** section, otherwise the
template text areas won't show. This is the default behavior so in most cases template text areas won't show. This is the default behavior so in most cases
you should be fine. you should be fine.
Go to your project's **Settings** and under the **Merge requests** header, click *Expand* and fill in the "Default description template 1. Go to your project's **Settings**.
for merge requests" text area. Under the **Default issue template**, click *Expand* and fill in "Default description template for issues" text area. Since GitLab merge request and issues 1. Click **Expand** under the **Merge requests** header.
support [Markdown](../markdown.md), you can use special markup like 1. Fill in the **Default description template for merge requests** text area.
headings, lists, etc. 1. Click **Expand** under **Default issue template**.
1. Fill in the **Default description template for issues** text area.
Since GitLab merge request and issues support [Markdown](../markdown.md), you can use it to format
headings, lists, and so on.
![Default merge request description templates](img/description_templates_merge_request_settings.png) ![Default merge request description templates](img/description_templates_merge_request_settings.png)
![Default issue description templates](img/description_templates_issue_settings.png) ![Default issue description templates](img/description_templates_issue_settings.png)
After you add the description, hit **Save changes** for the settings to take After you add the description, hit **Save changes** for the settings to take
...@@ -84,12 +84,16 @@ pre-filled with the text you entered in the template(s). ...@@ -84,12 +84,16 @@ pre-filled with the text you entered in the template(s).
## Description template example ## Description template example
We make use of Description Templates for Issues and Merge Requests within the GitLab Community Edition project. Please refer to the [`.gitlab` folder][gitlab-templates] for some examples. We make use of Description Templates for Issues and Merge Requests within the GitLab Community
Edition project. Please refer to the [`.gitlab` folder](https://gitlab.com/gitlab-org/gitlab/tree/master/.gitlab)
for some examples.
> **Tip:** TIP: **Tip:**
It is possible to use [quick actions](quick_actions.md) within description templates to quickly add labels, assignees, and milestones. The quick actions will only be executed if the user submitting the Issue or Merge Request has the permissions to perform the relevant actions. It's possible to use [quick actions](quick_actions.md) within description templates to quickly add
labels, assignees, and milestones. The quick actions will only be executed if the user submitting
the issue or merge request has the permissions to perform the relevant actions.
Here is an example for a Bug report template: Here is an example of a Bug report template:
```plaintext ```plaintext
Summary Summary
...@@ -133,9 +137,3 @@ Possible fixes ...@@ -133,9 +137,3 @@ Possible fixes
/cc @project-manager /cc @project-manager
/assign @qa-tester /assign @qa-tester
``` ```
[ce-4981]: https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/4981
[gitlab-templates]: https://gitlab.com/gitlab-org/gitlab/tree/master/.gitlab
[ee-28]: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/28 "Merge Request for adding issues template"
[ee-7478ece]: https://gitlab.com/gitlab-org/gitlab/commit/7478ece8b48e80782b5465b96c79f85cc91d391b "Commit that introduced merge requests templates"
[products]: https://about.gitlab.com/pricing/
doc/user/project/issue_board.md
View file @ 20a9ab33
# Issue Boards # Issue Boards
> [Introduced][ce-5554] in [GitLab 8.11](https://about.gitlab.com/releases/2016/08/22/gitlab-8-11-released/#issue-board). > [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/5554) in [GitLab 8.11](https://about.gitlab.com/releases/2016/08/22/gitlab-8-11-released/#issue-board).
## Overview ## Overview
The GitLab Issue Board is a software project management tool used to plan, The GitLab Issue Board is a software project management tool used to plan,
organize, and visualize a workflow for a feature or product release. organize, and visualize a workflow for a feature or product release.
It can be used as a [Kanban] or a [Scrum] board. It can be used as a [Kanban](https://en.wikipedia.org/wiki/Kanban_(development)) or a
[Scrum](https://en.wikipedia.org/wiki/Scrum_(software_development)) board.
It provides perfect pairing between issue tracking and project management, It provides perfect pairing between issue tracking and project management,
keeping everything in the same place, so that you don't need to jump keeping everything in the same place, so that you don't need to jump
...@@ -191,8 +192,10 @@ This allows you to create unique boards according to your team's need. ...@@ -191,8 +192,10 @@ This allows you to create unique boards according to your team's need.
![Create scoped board](img/issue_board_creation.png) ![Create scoped board](img/issue_board_creation.png)
You can define the scope of your board when creating it or by clicking on the "Edit board" button. Once a milestone, assignee or weight is assigned to an Issue Board, you will no longer be able to filter You can define the scope of your board when creating it or by clicking on the "Edit board" button.
through these in the search bar. In order to do that, you need to remove the desired scope (e.g. milestone, assignee or weight) from the Issue Board. Once a milestone, assignee or weight is assigned to an Issue Board, you will no longer be able to
filter through these in the search bar. In order to do that, you need to remove the desired scope
(for example, milestone, assignee, or weight) from the Issue Board.
![Edit board configuration](img/issue_board_edit_button.png) ![Edit board configuration](img/issue_board_edit_button.png)
...@@ -381,21 +384,21 @@ that order simply by dragging and dropping the issues. The changed order will be ...@@ -381,21 +384,21 @@ that order simply by dragging and dropping the issues. The changed order will be
to the system so that anybody who visits the same board later will see the reordering, to the system so that anybody who visits the same board later will see the reordering,
with some exceptions. with some exceptions.
The first time a given issue appears in any board (i.e. the first time a user The first time a given issue appears in any board (that is, the first time a user
loads a board containing that issue), it will be ordered with loads a board containing that issue), it is ordered with
respect to other issues in that list according to [Priority order](labels.md#label-priority). respect to other issues in that list according to [Priority order](labels.md#label-priority).
At that point, that issue will be assigned a relative order value by the system At that point, that issue is assigned a relative order value by the system
representing its relative order with respect to the other issues in the list. Any time representing its relative order with respect to the other issues in the list. Any time
you drag-and-drop reorder that issue, its relative order value will change accordingly. you drag-and-drop reorder that issue, its relative order value changes accordingly.
Also, any time that issue appears in any board when it is loaded by a user, Also, any time that issue appears in any board when it's loaded by a user,
the updated relative order value will be used for the ordering. (It's only the first the updated relative order value is used for the ordering. (It's only the first
time an issue appears that it takes from the Priority order mentioned above.) This means that time an issue appears that it takes from the Priority order mentioned above.) This means that
if issue `A` is drag-and-drop reordered to be above issue `B` by any user in if issue `A` is drag-and-drop reordered to be above issue `B` by any user in
a given board inside your GitLab instance, any time those two issues are subsequently a given board inside your GitLab instance, any time those two issues are subsequently
loaded in any board in the same instance (could be a different project board or a different group board, for example), loaded in any board in the same instance (could be a different project board or a different group
that ordering will be maintained. board, for example), that ordering is maintained.
This ordering also affects [issue lists](issues/sorting_issue_lists.md). This ordering also affects [issue lists](issues/sorting_issue_lists.md).
Changing the order in an issue board changes the ordering in an issue list, Changing the order in an issue board changes the ordering in an issue list,
...@@ -413,7 +416,7 @@ You can filter by author, assignee, milestone, and label. ...@@ -413,7 +416,7 @@ You can filter by author, assignee, milestone, and label.
By reordering your lists, you can create workflows. As lists in Issue Boards are By reordering your lists, you can create workflows. As lists in Issue Boards are
based on labels, it works out of the box with your existing issues. So if you've based on labels, it works out of the box with your existing issues. So if you've
already labeled things with 'Backend' and 'Frontend', the issue will appear in already labeled things with 'Backend' and 'Frontend', the issue appears in
the lists as you create them. In addition, this means you can easily move the lists as you create them. In addition, this means you can easily move
something between lists by changing a label. something between lists by changing a label.
...@@ -464,7 +467,7 @@ You can select multiple issue cards, then drag the group to another position wit ...@@ -464,7 +467,7 @@ You can select multiple issue cards, then drag the group to another position wit
To select and move multiple cards: To select and move multiple cards:
1. Select each card with <kbd>Ctrl</kbd>+`Click` on Windows or Linux, or <kbd>Cmd</kbd>+`Click` on MacOS. 1. Select each card with <kbd>Ctrl</kbd>+`Click` on Windows or Linux, or <kbd>Cmd</kbd>+`Click` on MacOS.
1. Drag one of the selected cards to another position or list and all selected cards will be moved. 1. Drag one of the selected cards to another position or list and all selected cards are moved.
![Multi-select Issue Cards](img/issue_boards_multi_select_v12_4.png) ![Multi-select Issue Cards](img/issue_boards_multi_select_v12_4.png)
...@@ -476,13 +479,9 @@ A few things to remember: ...@@ -476,13 +479,9 @@ A few things to remember:
and adds the label from the list it goes to. and adds the label from the list it goes to.
- An issue can exist in multiple lists if it has more than one label. - An issue can exist in multiple lists if it has more than one label.
- Lists are populated with issues automatically if the issues are labeled. - Lists are populated with issues automatically if the issues are labeled.
- Clicking on the issue title inside a card will take you to that issue. - Clicking on the issue title inside a card takes you to that issue.
- Clicking on a label inside a card will quickly filter the entire Issue Board - Clicking on a label inside a card quickly filters the entire Issue Board
and show only the issues from all lists that have that label. and show only the issues from all lists that have that label.
- For performance and visibility reasons, each list shows the first 20 issues - For performance and visibility reasons, each list shows the first 20 issues
by default. If you have more than 20 issues start scrolling down and the next by default. If you have more than 20 issues, start scrolling down and the next
20 will appear. 20 appears.
[ce-5554]: https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/5554
[scrum]: https://en.wikipedia.org/wiki/Scrum_(software_development)
[kanban]: https://en.wikipedia.org/wiki/Kanban_(development)
doc/user/todos.md
View file @ 20a9ab33
...@@ -4,7 +4,7 @@ disqus_identifier: 'https://docs.gitlab.com/ee/workflow/todos.html' ...@@ -4,7 +4,7 @@ disqus_identifier: 'https://docs.gitlab.com/ee/workflow/todos.html'
# GitLab To-Do List # GitLab To-Do List
> [Introduced][ce-2817] in GitLab 8.5. > [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/2817) in GitLab 8.5.
When you log into GitLab, you normally want to see where you should spend your When you log into GitLab, you normally want to see where you should spend your
time, take some action, or know what you need to keep an eye on without time, take some action, or know what you need to keep an eye on without
...@@ -29,7 +29,7 @@ displays on the To-Do List. ...@@ -29,7 +29,7 @@ displays on the To-Do List.
## What triggers a To Do ## What triggers a To Do
A To Do displays on your To-Do List when: A To Do appears on your To-Do List when:
- An issue or merge request is assigned to you - An issue or merge request is assigned to you
- You are `@mentioned` in the description or comment of an: - You are `@mentioned` in the description or comment of an:
...@@ -46,11 +46,13 @@ A To Do displays on your To-Do List when: ...@@ -46,11 +46,13 @@ A To Do displays on your To-Do List when:
To-do triggers are not affected by [GitLab Notification Email settings](profile/notifications.md). To-do triggers are not affected by [GitLab Notification Email settings](profile/notifications.md).
NOTE: **Note:** NOTE: **Note:**
When a user no longer has access to a resource related to a To Do (like an issue, merge request, project, or group) the related To-Do items are deleted within the next hour for security reasons. The delete is delayed to prevent data loss, in case the user's access was revoked by mistake. When a user no longer has access to a resource related to a To Do (like an issue, merge request,
project, or group) the related To-Do items are deleted within the next hour for security reasons.
The delete is delayed to prevent data loss, in case the user's access was revoked by mistake.
### Directly addressing a To Do ### Directly addressing a To Do
> [Introduced][ce-7926] in GitLab 9.0. > [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/7926) in GitLab 9.0.
If you are mentioned at the start of a line, the To Do you receive will be listed If you are mentioned at the start of a line, the To Do you receive will be listed
as 'directly addressed'. For example, in this comment: as 'directly addressed'. For example, in this comment:
...@@ -136,7 +138,12 @@ There are four kinds of filters you can use on your To-Do List. ...@@ -136,7 +138,12 @@ There are four kinds of filters you can use on your To-Do List.
| Type | Filter by issue, merge request, or epic **(ULTIMATE)** | | Type | Filter by issue, merge request, or epic **(ULTIMATE)** |
| Action | Filter by the action that triggered the To Do | | Action | Filter by the action that triggered the To Do |
You can also filter by more than one of these at the same time. The possible Actions are `Any Action`, `Assigned`, `Mentioned`, `Added`, `Pipelines`, and `Directly Addressed`, [as described above](#what-triggers-a-to-do). You can also filter by more than one of these at the same time. The possible Actions are
[described above](#what-triggers-a-to-do) and include:
[ce-2817]: https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/2817 - Any Action
[ce-7926]: https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/7926 - Assigned
- Mentioned
- Added
- Pipelines
- Directly Addressed
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