diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2022-11-03 06:10:45 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2022-11-03 06:10:45 +0300 |
commit | 26dfad7651130842a18a3c05c7a9731084da1695 (patch) | |
tree | 7ece60724f7be7381fb30a4de87fdba3a44ef27a /doc | |
parent | d81023e4e939cb2c689bf446f5baf724bc5faeaa (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc')
-rw-r--r-- | doc/.vale/gitlab/Wordy.yml | 1 | ||||
-rw-r--r-- | doc/api/runners.md | 60 | ||||
-rw-r--r-- | doc/user/application_security/sast/index.md | 2 | ||||
-rw-r--r-- | doc/user/project/repository/reducing_the_repo_size_using_git.md | 45 | ||||
-rw-r--r-- | doc/user/tasks.md | 2 |
5 files changed, 60 insertions, 50 deletions
diff --git a/doc/.vale/gitlab/Wordy.yml b/doc/.vale/gitlab/Wordy.yml index 8fe8a12f161..7432256efc9 100644 --- a/doc/.vale/gitlab/Wordy.yml +++ b/doc/.vale/gitlab/Wordy.yml @@ -14,3 +14,4 @@ swap: note that: "Be concise: rewrite the sentence to not use" please: "Remove this word from the sentence: " respectively: "Rewrite the sentence to be more precise, instead of using " + and so on: "Be more specific, rewrite the sentence to not use" diff --git a/doc/api/runners.md b/doc/api/runners.md index cb199f06159..b2377fda7d6 100644 --- a/doc/api/runners.md +++ b/doc/api/runners.md @@ -46,11 +46,11 @@ GET /runners?tag_list=tag1,tag2 | Attribute | Type | Required | Description | |------------|--------------|----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `scope` | string | no | Deprecated: Use `type` or `status` instead. The scope of specific runners to show, one of: `active`, `paused`, `online` and `offline`; showing all runners if none provided | -| `type` | string | no | The type of runners to show, one of: `instance_type`, `group_type`, `project_type` | -| `status` | string | no | The status of runners to show, one of: `online`, `offline`, `stale`, and `never_contacted`. `active` and `paused` are also possible values which were deprecated in GitLab 14.8 and will be removed in GitLab 16.0 | +| `scope` | string | no | Deprecated: Use `type` or `status` instead. The scope of specific runners to return, one of: `active`, `paused`, `online` and `offline`; showing all runners if none provided | +| `type` | string | no | The type of runners to return, one of: `instance_type`, `group_type`, `project_type` | +| `status` | string | no | The status of runners to return, one of: `online`, `offline`, `stale`, and `never_contacted`. `active` and `paused` are also possible values which were deprecated in GitLab 14.8 and will be removed in GitLab 16.0 | | `paused` | boolean | no | Whether to include only runners that are accepting or ignoring new jobs | -| `tag_list` | string array | no | List of the runner's tags | +| `tag_list` | string array | no | A list of runner tags | ```shell curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/runners" @@ -111,11 +111,11 @@ GET /runners/all?tag_list=tag1,tag2 | Attribute | Type | Required | Description | |------------|--------------|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `scope` | string | no | Deprecated: Use `type` or `status` instead. The scope of runners to show, one of: `specific`, `shared`, `active`, `paused`, `online` and `offline`; showing all runners if none provided | -| `type` | string | no | The type of runners to show, one of: `instance_type`, `group_type`, `project_type` | -| `status` | string | no | The status of runners to show, one of: `online`, `offline`, `stale`, and `never_contacted`. `active` and `paused` are also possible values which were deprecated in GitLab 14.8 and will be removed in GitLab 16.0 | +| `scope` | string | no | Deprecated: Use `type` or `status` instead. The scope of runners to return, one of: `specific`, `shared`, `active`, `paused`, `online` and `offline`; showing all runners if none provided | +| `type` | string | no | The type of runners to return, one of: `instance_type`, `group_type`, `project_type` | +| `status` | string | no | The status of runners to return, one of: `online`, `offline`, `stale`, and `never_contacted`. `active` and `paused` are also possible values which were deprecated in GitLab 14.8 and will be removed in GitLab 16.0 | | `paused` | boolean | no | Whether to include only runners that are accepting or ignoring new jobs | -| `tag_list` | string array | no | List of the runner's tags | +| `tag_list` | string array | no | A list of runner tags | ```shell curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/runners/all" @@ -260,17 +260,17 @@ Update details of a runner. PUT /runners/:id ``` -| Attribute | Type | Required | Description | -|-------------------|---------|----------|--------------------------------------------------------------------------------------------------| -| `id` | integer | yes | The ID of a runner | -| `description` | string | no | The description of a runner | -| `active` | boolean | no | Deprecated: Use `:paused` instead. Flag indicating whether the runner is allowed to receive jobs | -| `paused` | boolean | no | Flag indicating whether the runner should ignore new jobs | -| `tag_list` | array | no | The list of tags for a runner; put array of tags, that should be finally assigned to a runner | -| `run_untagged` | boolean | no | Flag indicating the runner can execute untagged jobs | -| `locked` | boolean | no | Flag indicating the runner is locked | -| `access_level` | string | no | The access_level of the runner; `not_protected` or `ref_protected` | -| `maximum_timeout` | integer | no | Maximum timeout set when this runner handles the job | +| Attribute | Type | Required | Description | +|-------------------|---------|----------|-------------------------------------------------------------------------------------------------| +| `id` | integer | yes | The ID of a runner | +| `description` | string | no | The description of the runner | +| `active` | boolean | no | Deprecated: Use `paused` instead. Flag indicating whether the runner is allowed to receive jobs | +| `paused` | boolean | no | Specifies whether the runner should ignore new jobs | +| `tag_list` | array | no | The list of tags for the runner | +| `run_untagged` | boolean | no | Specifies whether the runner can execute untagged jobs | +| `locked` | boolean | no | Specifies whether the runner is locked | +| `access_level` | string | no | The access level of the runner; `not_protected` or `ref_protected` | +| `maximum_timeout` | integer | no | Maximum timeout that limits the amount of time (in seconds) that runners can run jobs | ```shell curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/runners/6" \ @@ -370,7 +370,7 @@ GET /runners/:id/jobs |-----------|---------|----------|---------------------| | `id` | integer | yes | The ID of a runner | | `status` | string | no | Status of the job; one of: `running`, `success`, `failed`, `canceled` | -| `order_by`| string | no | Order jobs by `id`. | +| `order_by`| string | no | Order jobs by `id` | | `sort` | string | no | Sort jobs in `asc` or `desc` order (default: `desc`). Specify `order_by` as well, including for `id`. | ```shell @@ -463,11 +463,11 @@ GET /projects/:id/runners?tag_list=tag1,tag2 | Attribute | Type | Required | Description | |------------|----------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `id` | integer/string | yes | The ID or [URL-encoded path of the project](index.md#namespaced-path-encoding) owned by the authenticated user | -| `scope` | string | no | Deprecated: Use `type` or `status` instead. The scope of specific runners to show, one of: `active`, `paused`, `online` and `offline`; showing all runners if none provided | -| `type` | string | no | The type of runners to show, one of: `instance_type`, `group_type`, `project_type` | -| `status` | string | no | The status of runners to show, one of: `online`, `offline`, `stale`, and `never_contacted`. `active` and `paused` are also possible values which were deprecated in GitLab 14.8 and will be removed in GitLab 16.0 | +| `scope` | string | no | Deprecated: Use `type` or `status` instead. The scope of specific runners to return, one of: `active`, `paused`, `online` and `offline`; showing all runners if none provided | +| `type` | string | no | The type of runners to return, one of: `instance_type`, `group_type`, `project_type` | +| `status` | string | no | The status of runners to return, one of: `online`, `offline`, `stale`, and `never_contacted`. `active` and `paused` are also possible values which were deprecated in GitLab 14.8 and will be removed in GitLab 16.0 | | `paused` | boolean | no | Whether to include only runners that are accepting or ignoring new jobs | -| `tag_list` | string array | no | List of the runner's tags | +| `tag_list` | string array | no | A list of runner tags | ```shell curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/9/runners" @@ -580,10 +580,10 @@ GET /groups/:id/runners?tag_list=tag1,tag2 | Attribute | Type | Required | Description | |------------|----------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `id` | integer | yes | The ID of the group owned by the authenticated user | -| `type` | string | no | The type of runners to show, one of: `instance_type`, `group_type`, `project_type`. The `project_type` value is [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/351466) and will be removed in GitLab 15.0 | -| `status` | string | no | The status of runners to show, one of: `online`, `offline`, `stale`, and `never_contacted`. `active` and `paused` are also possible values which were deprecated in GitLab 14.8 and will be removed in GitLab 16.0 | +| `type` | string | no | The type of runners to return, one of: `instance_type`, `group_type`, `project_type`. The `project_type` value is [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/351466) and will be removed in GitLab 15.0 | +| `status` | string | no | The status of runners to return, one of: `online`, `offline`, `stale`, and `never_contacted`. `active` and `paused` are also possible values which were deprecated in GitLab 14.8 and will be removed in GitLab 16.0 | | `paused` | boolean | no | Whether to include only runners that are accepting or ignoring new jobs | -| `tag_list` | string array | no | List of the runner's tags | +| `tag_list` | string array | no | A list of runner tags | ```shell curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/9/runners" @@ -774,7 +774,7 @@ curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \ > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/30942) in GitLab 14.3. -Resets the runner registration token for a project. +Reset the runner registration token for a project. ```plaintext POST /projects/:id/runners/reset_registration_token @@ -789,7 +789,7 @@ curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \ > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/30942) in GitLab 14.3. -Resets the runner registration token for a group. +Reset the runner registration token for a group. ```plaintext POST /groups/:id/runners/reset_registration_token @@ -802,7 +802,7 @@ curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \ ## Reset runner's authentication token by using the runner ID -Resets the runner's authentication token by using its runner ID. +Reset the runner's authentication token by using its runner ID. ```plaintext POST /runners/:id/reset_authentication_token diff --git a/doc/user/application_security/sast/index.md b/doc/user/application_security/sast/index.md index 3f63fb6a2cd..362874d5b29 100644 --- a/doc/user/application_security/sast/index.md +++ b/doc/user/application_security/sast/index.md @@ -356,6 +356,8 @@ Advanced vulnerability tracking is available in a subset of the [supported langu Support for more languages and analyzers is tracked in [this epic](https://gitlab.com/groups/gitlab-org/-/epics/5144). +For more information, see the confidential project `https://gitlab.com/gitlab-org/security-products/post-analyzers/tracking-calculator`. The content of this project is available only to GitLab team members. + ### Using CI/CD variables to pass credentials for private repositories Some analyzers require downloading the project's dependencies to diff --git a/doc/user/project/repository/reducing_the_repo_size_using_git.md b/doc/user/project/repository/reducing_the_repo_size_using_git.md index c85dd4555ca..9c977e4da40 100644 --- a/doc/user/project/repository/reducing_the_repo_size_using_git.md +++ b/doc/user/project/repository/reducing_the_repo_size_using_git.md @@ -72,6 +72,12 @@ To purge files from a GitLab repository: cd project.git ``` +1. Because cloning from a bundle file sets the `origin` remote to the local bundle file, change it to the URL of your repository: + + ```shell + git remote set-url origin https://gitlab.example.com/<namespace>/<project_name>.git + ``` + 1. Using either `git filter-repo` or `git-sizer`, analyze your repository and review the results to determine which items you want to purge: @@ -84,38 +90,39 @@ To purge files from a GitLab repository: git-sizer ``` -1. Proceed to purging any files from the history of your repository. Because we are - trying to remove internal refs, we rely on the `commit-map` produced by each run to tell us - which internal refs to remove. - - NOTE: - `git filter-repo` creates a new `commit-map` file every run, and overwrites the `commit-map` from - the previous run. You need this file from **every** run. Do the next step every time you run - `git filter-repo`. +1. Purge the history of your repository using relevant `git filter-repo` options. + Two common options are: - To purge specific files, the `--path` and `--invert-paths` options can be combined: + - `--path` and `--invert-paths` to purge specific files: - ```shell - git filter-repo --path path/to/file.ext --invert-paths - ``` + ```shell + git filter-repo --path path/to/file.ext --invert-paths + ``` - To generally purge all files larger than 10M, the `--strip-blobs-bigger-than` option can be used: + - `--strip-blobs-bigger-than` to purge all files larger than for example 10M: - ```shell - git filter-repo --strip-blobs-bigger-than 10M - ``` + ```shell + git filter-repo --strip-blobs-bigger-than 10M + ``` See the [`git filter-repo` documentation](https://htmlpreview.github.io/?https://github.com/newren/git-filter-repo/blob/docs/html/git-filter-repo.html#EXAMPLES) for more examples and the complete documentation. -1. Because cloning from a bundle file sets the `origin` remote to the local bundle file, delete this `origin` remote, and set it to the URL to your repository: +1. Because you are trying to remove internal refs, + you'll later rely on `commit-map` files produced by each run + to tell you which internal refs to remove. + Every `git filter-repo` run creates a new `commit-map`, + and overwrites the `commit-map` from the previous run. + You can use the following command to back up each `commit-map` file: ```shell - git remote remove origin - git remote add origin https://gitlab.example.com/<namespace>/<project_name>.git + cp .git/filter-repo/commit-map ./_filter_repo_commit_map_$(date +%s) ``` + Repeat this step and all following steps (including the [repository cleanup](#repository-cleanup) step) + every time you run any `git filter-repo` command. + 1. Force push your changes to overwrite all branches on GitLab: ```shell diff --git a/doc/user/tasks.md b/doc/user/tasks.md index 10a86724bf1..bc83e09a052 100644 --- a/doc/user/tasks.md +++ b/doc/user/tasks.md @@ -18,7 +18,7 @@ For the latest updates, check the [Tasks Roadmap](https://gitlab.com/groups/gitl FLAG: On self-managed GitLab, by default this feature is available. To hide the feature, -ask an administrator to [disable the feature flags](../administration/feature_flags.md) named `work_items` and `work_items_hierarchy`. +ask an administrator to [disable the feature flags](../administration/feature_flags.md) named `work_items`. On GitLab.com, this feature is available. Use tasks to track steps needed for the [issue](project/issues/index.md) to be closed. |