diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api/epics.md | 2 | ||||
| -rw-r--r-- | doc/ci/review_apps/img/enable_review_app_v12_8.png | bin | 0 -> 46424 bytes | |||
| -rw-r--r-- | doc/ci/review_apps/index.md | 24 | ||||
| -rw-r--r-- | doc/user/permissions.md | 1 | ||||
| -rw-r--r-- | doc/user/project/insights/img/insights_example_pie_chart.png | bin | 6985 -> 0 bytes | |||
| -rw-r--r-- | doc/user/project/insights/index.md | 3 |
6 files changed, 26 insertions, 4 deletions
diff --git a/doc/api/epics.md b/doc/api/epics.md index 078bdfdba69..b8eb1ab9f9a 100644 --- a/doc/api/epics.md +++ b/doc/api/epics.md @@ -1,4 +1,4 @@ -# Epics API **(ULTIMATE)** +# Epics API **(PREMIUM)** Every API call to epic must be authenticated. diff --git a/doc/ci/review_apps/img/enable_review_app_v12_8.png b/doc/ci/review_apps/img/enable_review_app_v12_8.png Binary files differnew file mode 100644 index 00000000000..364fe402787 --- /dev/null +++ b/doc/ci/review_apps/img/enable_review_app_v12_8.png diff --git a/doc/ci/review_apps/index.md b/doc/ci/review_apps/index.md index 23cb0362867..cc081f2543a 100644 --- a/doc/ci/review_apps/index.md +++ b/doc/ci/review_apps/index.md @@ -55,9 +55,31 @@ The process of configuring Review Apps is as follows: 1. Set up the infrastructure to host and deploy the Review Apps (check the [examples](#review-apps-examples) below). 1. [Install](https://docs.gitlab.com/runner/install/) and [configure](https://docs.gitlab.com/runner/commands/) a Runner to do deployment. -1. Set up a job in `.gitlab-ci.yml` that uses the [predefined CI environment variable](../variables/README.md) `${CI_COMMIT_REF_NAME}` to create dynamic environments and restrict it to run only on branches. +1. Set up a job in `.gitlab-ci.yml` that uses the [predefined CI environment variable](../variables/README.md) `${CI_COMMIT_REF_NAME}` + to create dynamic environments and restrict it to run only on branches. + Alternatively, you can get a YML template for this job by [enabling review apps](#enable-review-apps-button) for your project. 1. Optionally, set a job that [manually stops](../environments.md#stopping-an-environment) the Review Apps. +### Enable Review Apps button + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/issues/118844) in GitLab 12.8. + +When configuring Review Apps for a project, you need to add a new job to `.gitlab-ci.yml`, +as mentioned above. To facilitate this and if you are using Kubernetes, you can click +the **Enable Review Apps** button and GitLab will prompt you with a template code block that +you can copy and paste into `.gitlab-ci.yml` as a starting point. To do so: + +1. Go to the project your want to create a Review App job for. +1. From the left nav, go to **Operations** > **Environments**. +1. Click on the **Enable Review Apps** button. It is available to you + if you have Developer or higher [permissions](../../user/permissions.md) to that project. +1. Copy the provided code snippet and paste it into your + `.gitlab-ci.yml` file: + +  + +1. Feel free to tune this template to your own needs. + ## Review Apps examples The following are example projects that demonstrate Review App configuration: diff --git a/doc/user/permissions.md b/doc/user/permissions.md index 4f42afe4e79..8cf60342446 100644 --- a/doc/user/permissions.md +++ b/doc/user/permissions.md @@ -93,6 +93,7 @@ The following table depicts the various user permission levels in a project. | Manage/Accept merge requests | | | ✓ | ✓ | ✓ | | Create new environments | | | ✓ | ✓ | ✓ | | Stop environments | | | ✓ | ✓ | ✓ | +| Enable Review Apps | | | ✓ | ✓ | ✓ | | Add tags | | | ✓ | ✓ | ✓ | | Cancel and retry jobs | | | ✓ | ✓ | ✓ | | Create or update commit status | | | ✓ (*5*) | ✓ | ✓ | diff --git a/doc/user/project/insights/img/insights_example_pie_chart.png b/doc/user/project/insights/img/insights_example_pie_chart.png Binary files differdeleted file mode 100644 index 3480bce6738..00000000000 --- a/doc/user/project/insights/img/insights_example_pie_chart.png +++ /dev/null diff --git a/doc/user/project/insights/index.md b/doc/user/project/insights/index.md index ec3831f2d27..3fb661f9349 100644 --- a/doc/user/project/insights/index.md +++ b/doc/user/project/insights/index.md @@ -96,7 +96,7 @@ The following table lists available parameters for charts: | Keyword | Description | |:---------------------------------------------------|:------------| | [`title`](#title) | The title of the chart. This will displayed on the Insights page. | -| [`type`](#type) | The type of chart: `bar`, `line`, `stacked-bar`, `pie` etc. | +| [`type`](#type) | The type of chart: `bar`, `line` or `stacked-bar`. | | [`query`](#query) | A hash that defines the conditions for issues / merge requests to be part of the chart. | ## Parameter details @@ -132,7 +132,6 @@ Supported values are: | ----- | ------- | | `bar` |  | | `bar` (time series, i.e. when `group_by` is used) |  | -| `pie` |  | | `line` |  | | `stacked-bar` |  | |
