From e0fa0638a422c3e20d4423c9bb69d79afc9c7d3d Mon Sep 17 00:00:00 2001 From: GitLab Bot Date: Thu, 27 Feb 2020 18:09:21 +0000 Subject: Add latest changes from gitlab-org/gitlab@master --- doc/api/graphql/reference/gitlab_schema.graphql | 21 ++++++++++++++++++++ doc/api/graphql/reference/index.md | 23 +++++++++++++++++----- doc/api/notification_settings.md | 4 ++++ doc/integration/elasticsearch.md | 6 +++--- .../license_compliance/index.md | 2 +- doc/user/profile/notifications.md | 3 ++- 6 files changed, 49 insertions(+), 10 deletions(-) (limited to 'doc') diff --git a/doc/api/graphql/reference/gitlab_schema.graphql b/doc/api/graphql/reference/gitlab_schema.graphql index 5cf48ab901d..6b62b11750c 100644 --- a/doc/api/graphql/reference/gitlab_schema.graphql +++ b/doc/api/graphql/reference/gitlab_schema.graphql @@ -1862,6 +1862,12 @@ type Epic implements Noteable { """ descendantCounts: EpicDescendantCount + """ + Total weight of open and closed descendant epic's issues. Available only when + feature flag unfiltered_epic_aggregates is enabled. + """ + descendantWeightSum: EpicDescendantWeights + """ Description of the epic """ @@ -2178,6 +2184,21 @@ type EpicDescendantCount { openedIssues: Int } +""" +Total weight of open and closed descendant issues +""" +type EpicDescendantWeights { + """ + Total weight of completed (closed) issues in this epic, including epic descendants + """ + closedIssues: Int + + """ + Total weight of opened issues in this epic, including epic descendants + """ + openedIssues: Int +} + """ An edge in a connection. """ diff --git a/doc/api/graphql/reference/index.md b/doc/api/graphql/reference/index.md index 978fbc35125..1a9be3f496b 100644 --- a/doc/api/graphql/reference/index.md +++ b/doc/api/graphql/reference/index.md @@ -13,6 +13,9 @@ The API can be explored interactively using the [GraphiQL IDE](../index.md#graph Each table below documents a GraphQL type. Types match loosely to models, but not all fields and methods on a model are available via GraphQL. +CAUTION: **Caution:** +Fields that are deprecated are marked with **{warning-solid}**. + ## AddAwardEmojiPayload Autogenerated return type of AddAwardEmoji @@ -69,7 +72,7 @@ Represents a project or group board | `authoredDate` | Time | Timestamp of when the commit was authored | | `description` | String | Description of the commit message | | `id` | ID! | ID (global ID) of the commit | -| `latestPipeline` | Pipeline | Latest pipeline of the commit | +| `latestPipeline` **{warning-solid}** | Pipeline | **Deprecated:** Use pipelines | | `message` | String | Raw commit message | | `sha` | String! | SHA1 ID of the commit | | `signatureHtml` | String | Rendered HTML of the commit signature | @@ -294,6 +297,7 @@ Represents an epic. | `closedAt` | Time | Timestamp of the epic's closure | | `createdAt` | Time | Timestamp of the epic's creation | | `descendantCounts` | EpicDescendantCount | Number of open and closed descendant epics and issues | +| `descendantWeightSum` | EpicDescendantWeights | Total weight of open and closed descendant epic's issues. Available only when feature flag unfiltered_epic_aggregates is enabled. | | `description` | String | Description of the epic | | `downvotes` | Int! | Number of downvotes the epic has received | | `dueDate` | Time | Due date of the epic | @@ -334,6 +338,15 @@ Counts of descendent epics. | `openedEpics` | Int | Number of opened sub-epics | | `openedIssues` | Int | Number of opened epic issues | +## EpicDescendantWeights + +Total weight of open and closed descendant issues + +| Name | Type | Description | +| --- | ---- | ---------- | +| `closedIssues` | Int | Total weight of completed (closed) issues in this epic, including epic descendants | +| `openedIssues` | Int | Total weight of opened issues in this epic, including epic descendants | + ## EpicIssue Relationship between an epic and an issue @@ -347,7 +360,7 @@ Relationship between an epic and an issue | `description` | String | Description of the issue | | `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` | | `designCollection` | DesignCollection | Collection of design images associated with this issue | -| `designs` | DesignCollection | Deprecated. Use `designCollection` | +| `designs` **{warning-solid}** | DesignCollection | **Deprecated:** Use designCollection | | `discussionLocked` | Boolean! | Indicates discussion is locked on the issue | | `downvotes` | Int! | Number of downvotes the issue has received | | `dueDate` | Time | Due date of the issue | @@ -417,7 +430,7 @@ Autogenerated return type of EpicTreeReorder | `enabled` | Boolean! | Indicates whether Grafana integration is enabled | | `grafanaUrl` | String! | Url for the Grafana host for the Grafana integration | | `id` | ID! | Internal ID of the Grafana integration | -| `token` | String! | API token for the Grafana integration. Field is permanently masked. | +| `token` **{warning-solid}** | String! | **Deprecated:** Plain text token has been masked for security reasons | | `updatedAt` | Time! | Timestamp of the issue's last activity | ## Group @@ -469,7 +482,7 @@ Autogenerated return type of EpicTreeReorder | `description` | String | Description of the issue | | `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` | | `designCollection` | DesignCollection | Collection of design images associated with this issue | -| `designs` | DesignCollection | Deprecated. Use `designCollection` | +| `designs` **{warning-solid}** | DesignCollection | **Deprecated:** Use designCollection | | `discussionLocked` | Boolean! | Indicates discussion is locked on the issue | | `downvotes` | Int! | Number of downvotes the issue has received | | `dueDate` | Time | Due date of the issue | @@ -578,7 +591,7 @@ Autogenerated return type of MarkAsSpamSnippet | `id` | ID! | ID of the merge request | | `iid` | String! | Internal ID of the merge request | | `inProgressMergeCommitSha` | String | Commit SHA of the merge request if merge is in progress | -| `mergeCommitMessage` | String | Deprecated - renamed to defaultMergeCommitMessage | +| `mergeCommitMessage` **{warning-solid}** | String | **Deprecated:** Renamed to defaultMergeCommitMessage | | `mergeCommitSha` | String | SHA of the merge request commit (set once merged) | | `mergeError` | String | Error message due to a merge error | | `mergeOngoing` | Boolean! | Indicates if a merge is currently occurring | diff --git a/doc/api/notification_settings.md b/doc/api/notification_settings.md index 38a5e350bee..596365743fa 100644 --- a/doc/api/notification_settings.md +++ b/doc/api/notification_settings.md @@ -30,6 +30,7 @@ If the `custom` level is used, specific email events can be controlled. Availabl - `reassign_merge_request` - `merge_merge_request` - `failed_pipeline` +- `fixed_pipeline` - `success_pipeline` - `new_epic` **(ULTIMATE)** @@ -83,6 +84,7 @@ curl --request PUT --header "PRIVATE-TOKEN: " https://gitlab. | `reassign_merge_request` | boolean | no | Enable/disable this notification | | `merge_merge_request` | boolean | no | Enable/disable this notification | | `failed_pipeline` | boolean | no | Enable/disable this notification | +| `fixed_pipeline` | boolean | no | Enable/disable this notification | | `success_pipeline` | boolean | no | Enable/disable this notification | | `new_epic` | boolean | no | Enable/disable this notification ([Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/6626) in 11.3) **(ULTIMATE)** | @@ -152,6 +154,7 @@ curl --request PUT --header "PRIVATE-TOKEN: " https://gitlab. | `reassign_merge_request` | boolean | no | Enable/disable this notification | | `merge_merge_request` | boolean | no | Enable/disable this notification | | `failed_pipeline` | boolean | no | Enable/disable this notification | +| `fixed_pipeline` | boolean | no | Enable/disable this notification | | `success_pipeline` | boolean | no | Enable/disable this notification | | `new_epic` | boolean | no | Enable/disable this notification ([Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/6626) in 11.3) **(ULTIMATE)** | @@ -178,6 +181,7 @@ Example responses: "reassign_merge_request": false, "merge_merge_request": false, "failed_pipeline": false, + "fixed_pipeline": false, "success_pipeline": false } } diff --git a/doc/integration/elasticsearch.md b/doc/integration/elasticsearch.md index cffd261e757..9ec56d304e0 100644 --- a/doc/integration/elasticsearch.md +++ b/doc/integration/elasticsearch.md @@ -50,12 +50,12 @@ For indexing Git repository data, GitLab uses an [indexer written in Go](https:/ The way you install the Go indexer depends on your version of GitLab: - For GitLab Omnibus 11.8 and above, see [GitLab Omnibus](#gitlab-omnibus). -- For older versions of GitLab, install the indexer [From Source](#from-source). +- For installations from source or older versions of GitLab Omnibus, install the indexer [From Source](#from-source). ### GitLab Omnibus -The Go indexer was included in Omnibus GitLab 11.8 as an optional replacement to a -Ruby-based indexer. [Since GitLab v12.3](https://gitlab.com/gitlab-org/gitlab/issues/6481), +Since GitLab 11.8 the Go indexer is included in GitLab Omnibus. +The former Ruby-based indexer was removed in [GitLab 12.3](https://gitlab.com/gitlab-org/gitlab/issues/6481). ### From source diff --git a/doc/user/application_security/license_compliance/index.md b/doc/user/application_security/license_compliance/index.md index dfe7a714f6c..03a7ffd195a 100644 --- a/doc/user/application_security/license_compliance/index.md +++ b/doc/user/application_security/license_compliance/index.md @@ -216,7 +216,7 @@ If you're using a custom setup for License Compliance, you're required to update your CI config accordingly: 1. Change the CI template to `License-Scanning.gitlab-ci.yml`. -1. Change the job name to `license_management` (if you mention it in `.gitlab-ci.yml`). +1. Change the job name to `license_scanning` (if you mention it in `.gitlab-ci.yml`). 1. Change the artifact name to `gl-license-scanning-report.json` (if you mention it in `.gitlab-ci.yml`). For example, the following `.gitlab-ci.yml`: diff --git a/doc/user/profile/notifications.md b/doc/user/profile/notifications.md index 96ae8d04e03..588c471bb64 100644 --- a/doc/user/profile/notifications.md +++ b/doc/user/profile/notifications.md @@ -178,7 +178,8 @@ In most of the below cases, the notification will be sent to: | Remove milestone merge request | Subscribers, participants mentioned, and Custom notification level with this event selected | | New comment | The above, plus anyone mentioned by `@username` in the comment, with notification level "Mention" or higher | | Failed pipeline | The author of the pipeline | -| Successful pipeline | The author of the pipeline, if they have the custom notification setting for successful pipelines set | +| Fixed pipeline | The author of the pipeline | +| Successful pipeline | The author of the pipeline, if they have the custom notification setting for successful pipelines set. If the pipeline failed previously, a `Fixed pipeline` message will be sent for the first successful pipeline after the failure, then a `Successful pipeline` message for any further successful pipelines. | | New epic **(ULTIMATE)** | | | Close epic **(ULTIMATE)** | | | Reopen epic **(ULTIMATE)** | | -- cgit v1.2.3