diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2023-12-05 21:10:06 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2023-12-05 21:10:06 +0300 |
commit | c8419b0227e069a7403f41589f1d0ef690e762f1 (patch) | |
tree | 7009382402811f9e32b448f68f7f90912237aa03 /doc | |
parent | 6659634b2bdc3ba362574541985c6852ad1574a4 (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc')
27 files changed, 167 insertions, 109 deletions
diff --git a/doc/administration/backup_restore/backup_gitlab.md b/doc/administration/backup_restore/backup_gitlab.md index 49ae2311ab6..b7834fb3fce 100644 --- a/doc/administration/backup_restore/backup_gitlab.md +++ b/doc/administration/backup_restore/backup_gitlab.md @@ -291,7 +291,7 @@ Deleting old backups... [SKIPPING] ### Backup timestamp The backup archive is saved in `backup_path`, which is specified in the -`config/gitlab.yml` file. The default path is `/var/opt/gitlab/backups`. The filename is `[TIMESTAMP]_gitlab_backup.tar`, +`config/gitlab.yml` file. The default path is `/var/opt/gitlab/backups`. The file name is `[TIMESTAMP]_gitlab_backup.tar`, where `TIMESTAMP` identifies the time at which each backup was created, plus the GitLab version. The timestamp is needed if you need to restore GitLab and multiple backups are available. @@ -327,15 +327,15 @@ To use the `copy` strategy instead of the default streaming strategy, specify sudo gitlab-backup create STRATEGY=copy ``` -#### Backup filename +#### Backup file name WARNING: -If you use a custom backup filename, you can't +If you use a custom backup file name, you can't [limit the lifetime of the backups](#limit-backup-lifetime-for-local-files-prune-old-backups). By default, a backup file is created according to the specification in the previous [Backup timestamp](#backup-timestamp) section. You can, however, -override the `[TIMESTAMP]` portion of the filename by setting the `BACKUP` +override the `[TIMESTAMP]` portion of the file name by setting the `BACKUP` environment variable. For example: ```shell @@ -359,7 +359,7 @@ Caveats: - The compression command is used in a pipeline, so your custom command must output to `stdout`. - If you specify a command that is not packaged with GitLab, then you must install it yourself. -- The resultant filenames will still end in `.gz`. +- The resultant file names will still end in `.gz`. - The default decompression command, used during restore, is `gzip -cd`. Therefore if you override the compression command to use a format that cannot be decompressed by `gzip -cd`, you must override the decompression command during restore. ##### Default compression: Gzip with fastest method @@ -440,7 +440,7 @@ sudo gitlab-backup restore DECOMPRESS_CMD="zstd --decompress --stdout" To ensure the generated archive is transferable by rsync, you can set the `GZIP_RSYNCABLE=yes` option. This sets the `--rsyncable` option to `gzip`, which is useful only in -combination with setting [the Backup filename option](#backup-filename). +combination with setting [the Backup file name option](#backup-file-name). The `--rsyncable` option in `gzip` isn't guaranteed to be available on all distributions. To verify that it's available in your distribution, run @@ -615,8 +615,8 @@ to create an incremental backup from: - In GitLab 14.9 and 14.10, use the `BACKUP=<timestamp_of_backup>` option to choose the backup to use. The chosen previous backup is overwritten. - In GitLab 15.0 and later, use the `PREVIOUS_BACKUP=<timestamp_of_backup>` option to choose the backup to use. By default, a backup file is created - as documented in the [Backup timestamp](#backup-timestamp) section. You can override the `[TIMESTAMP]` portion of the filename by setting the - [`BACKUP` environment variable](#backup-filename). + as documented in the [Backup timestamp](#backup-timestamp) section. You can override the `[TIMESTAMP]` portion of the file name by setting the + [`BACKUP` environment variable](#backup-file-name). To create an incremental backup, run: @@ -1208,7 +1208,7 @@ When troubleshooting backup problems, however, replace `CRON=1` with `--trace` t #### Limit backup lifetime for local files (prune old backups) WARNING: -The process described in this section doesn't work if you used a [custom filename](#backup-filename) +The process described in this section doesn't work if you used a [custom file name](#backup-file-name) for your backups. To prevent regular backups from using all your disk space, you may want to set a limited lifetime @@ -1770,16 +1770,16 @@ During backup, you can get the `File name too long` error ([issue #354984](https Problem: <class 'OSError: [Errno 36] File name too long: ``` -This problem stops the backup script from completing. To fix this problem, you must truncate the filenames causing the problem. A maximum of 246 characters, including the file extension, is permitted. +This problem stops the backup script from completing. To fix this problem, you must truncate the file names causing the problem. A maximum of 246 characters, including the file extension, is permitted. WARNING: The steps in this section can potentially lead to **data loss**. All steps must be followed strictly in the order given. Consider opening a [Support Request](https://support.gitlab.com/hc/en-us/requests/new) if you're a Premium or Ultimate customer. -Truncating filenames to resolve the error involves: +Truncating file names to resolve the error involves: - Cleaning up remote uploaded files that aren't tracked in the database. -- Truncating the filenames in the database. +- Truncating the file names in the database. - Rerunning the backup task. #### Clean up remote uploaded files @@ -1803,15 +1803,15 @@ To fix these files, you must clean up all remote uploaded files that are in the bundle exec rake gitlab:cleanup:remote_upload_files RAILS_ENV=production DRY_RUN=false ``` -#### Truncate the filenames referenced by the database +#### Truncate the file names referenced by the database -You must truncate the files referenced by the database that are causing the problem. The filenames referenced by the database are stored: +You must truncate the files referenced by the database that are causing the problem. The file names referenced by the database are stored: - In the `uploads` table. - In the references found. Any reference found from other database tables and columns. - On the file system. -Truncate the filenames in the `uploads` table: +Truncate the file names in the `uploads` table: 1. Enter the database console: @@ -1839,9 +1839,9 @@ Truncate the filenames in the `uploads` table: sudo -u git -H bundle exec rails dbconsole -e production ``` -1. Search the `uploads` table for filenames longer than 246 characters: +1. Search the `uploads` table for file names longer than 246 characters: - The following query selects the `uploads` records with filenames longer than 246 characters in batches of 0 to 10000. This improves the performance on large GitLab instances with tables having thousand of records. + The following query selects the `uploads` records with file names longer than 246 characters in batches of 0 to 10000. This improves the performance on large GitLab instances with tables having thousand of records. ```sql CREATE TEMP TABLE uploads_with_long_filenames AS @@ -1892,7 +1892,7 @@ Truncate the filenames in the `uploads` table: After you validate the batch results, you must change the batch size (`row_id`) using the following sequence of numbers (10000 to 20000). Repeat this process until you reach the last record in the `uploads` table. -1. Rename the files found in the `uploads` table from long filenames to new truncated filenames. The following query rolls back the update so you can check the results safely in a transaction wrapper: +1. Rename the files found in the `uploads` table from long file names to new truncated file names. The following query rolls back the update so you can check the results safely in a transaction wrapper: ```sql CREATE TEMP TABLE uploads_with_long_filenames AS @@ -1927,7 +1927,7 @@ Truncate the filenames in the `uploads` table: After you validate the batch update results, you must change the batch size (`row_id`) using the following sequence of numbers (10000 to 20000). Repeat this process until you reach the last record in the `uploads` table. -1. Validate that the new filenames from the previous query are the expected ones. If you are sure you want to truncate the records found in the previous step to 246 characters, run the following: +1. Validate that the new file names from the previous query are the expected ones. If you are sure you want to truncate the records found in the previous step to 246 characters, run the following: WARNING: The following action is **irreversible**. @@ -1959,9 +1959,9 @@ Truncate the filenames in the `uploads` table: After you finish the batch update, you must change the batch size (`updatable_uploads.row_id`) using the following sequence of numbers (10000 to 20000). Repeat this process until you reach the last record in the `uploads` table. -Truncate the filenames in the references found: +Truncate the file names in the references found: -1. Check if those records are referenced somewhere. One way to do this is to dump the database and search for the parent directory name and filename: +1. Check if those records are referenced somewhere. One way to do this is to dump the database and search for the parent directory name and file name: 1. To dump your database, you can use the following command as an example: @@ -1969,15 +1969,15 @@ Truncate the filenames in the references found: pg_dump -h /var/opt/gitlab/postgresql/ -d gitlabhq_production > gitlab-dump.tmp ``` - 1. Then you can search for the references using the `grep` command. Combining the parent directory and the filename can be a good idea. For example: + 1. Then you can search for the references using the `grep` command. Combining the parent directory and the file name can be a good idea. For example: ```shell grep public/alongfilenamehere.txt gitlab-dump.tmp ``` -1. Replace those long filenames using the new filenames obtained from querying the `uploads` table. +1. Replace those long file names using the new file names obtained from querying the `uploads` table. -Truncate the filenames on the file system. You must manually rename the files in your file system to the new filenames obtained from querying the `uploads` table. +Truncate the file names on the file system. You must manually rename the files in your file system to the new file names obtained from querying the `uploads` table. #### Re-run the backup task diff --git a/doc/administration/backup_restore/backup_large_reference_architectures.md b/doc/administration/backup_restore/backup_large_reference_architectures.md index 8552024e5ac..e859985e59e 100644 --- a/doc/administration/backup_restore/backup_large_reference_architectures.md +++ b/doc/administration/backup_restore/backup_large_reference_architectures.md @@ -96,7 +96,7 @@ To back up the Git repositories: sudo gitlab-backup create SKIP=db ``` - The resulting tar file will include only the Git repositories and some metadata. Blobs such as uploads, artifacts, and LFS do not need to be explicitly skipped, because the command does not back up object storage by default. The tar file will be created in the [`/var/opt/gitlab/backups` directory](https://docs.gitlab.com/omnibus/settings/backups.html#creating-an-application-backup) and [the filename will end in `_gitlab_backup.tar`](backup_gitlab.md#backup-timestamp). + The resulting tar file will include only the Git repositories and some metadata. Blobs such as uploads, artifacts, and LFS do not need to be explicitly skipped, because the command does not back up object storage by default. The tar file will be created in the [`/var/opt/gitlab/backups` directory](https://docs.gitlab.com/omnibus/settings/backups.html#creating-an-application-backup) and [the file name will end in `_gitlab_backup.tar`](backup_gitlab.md#backup-timestamp). Since we configured uploading backups to remote cloud storage, the tar file will be uploaded to the remote region and deleted from disk. diff --git a/doc/administration/dedicated/index.md b/doc/administration/dedicated/index.md index d59a36e452b..01ce8458aff 100644 --- a/doc/administration/dedicated/index.md +++ b/doc/administration/dedicated/index.md @@ -214,12 +214,26 @@ Make sure the AWS KMS keys are replicated to your desired primary, secondary and ## Configuration changes +### Configuration change policy + +Configuration changes are batched up and applied during your environment's weekly four-hour maintenance +window. + +To have a change considered for an upcoming weekly maintenance window, all required information +must be submitted in full two business days before the start of the window. + +If there is insufficient time to complete a configuration change during the weekly maintenance +window, it will postponed to the following week. + +Changes cannot be applied outside of a weekly maintenance window unless it qualifies for +[emergency support](https://about.gitlab.com/support/#how-to-engage-emergency-support). + +### Making configuration changes + Switchboard empowers the user to make limited configuration changes to their Dedicated Tenant Instance. As Switchboard matures further configuration changes will be made available. To change or update the configuration of your GitLab Dedicated instance, use Switchboard following the instructions in the relevant section or open a [support ticket](https://support.gitlab.com/hc/en-us/requests/new?ticket_form_id=4414917877650) with your request. You can request configuration changes for the options originally specified during onboarding, or for any of the following optional features. -The turnaround time to process configuration change requests is [documented in the GitLab handbook](https://about.gitlab.com/handbook/engineering/infrastructure/team/gitlab-dedicated/#handling-configuration-changes-for-tenant-environments). - ### Inbound Private Link [AWS Private Link](https://docs.aws.amazon.com/vpc/latest/privatelink/what-is-privatelink.html) allows users and applications in your VPC on AWS to securely connect to the GitLab Dedicated endpoint without network traffic going over the public internet. diff --git a/doc/administration/gitaly/configure_gitaly.md b/doc/administration/gitaly/configure_gitaly.md index 535e35cc012..888bf6d6a3b 100644 --- a/doc/administration/gitaly/configure_gitaly.md +++ b/doc/administration/gitaly/configure_gitaly.md @@ -971,7 +971,7 @@ By default, the cache storage directory is set to a subdirectory of the first Gi defined in the configuration file. Multiple Gitaly processes can use the same directory for cache storage. Each Gitaly process -uses a unique random string as part of the cache filenames it creates. This means: +uses a unique random string as part of the cache file names it creates. This means: - They do not collide. - They do not reuse another process's files. diff --git a/doc/administration/gitaly/praefect.md b/doc/administration/gitaly/praefect.md index b17cb2a4337..7b34234a26a 100644 --- a/doc/administration/gitaly/praefect.md +++ b/doc/administration/gitaly/praefect.md @@ -50,7 +50,7 @@ default value. The default value depends on the GitLab version. Network latency for Gitaly Cluster should ideally be measurable in single-digit milliseconds. Latency is particularly important for: -- Gitaly node health checks. Nodes must be able to respond 1 second or faster. +- Gitaly node health checks. Nodes must be able to respond within 1 second. - Reference transactions that enforce [strong consistency](index.md#strong-consistency). Lower latencies mean Gitaly nodes can agree on changes faster. diff --git a/doc/administration/gitaly/troubleshooting.md b/doc/administration/gitaly/troubleshooting.md index b8d3d38d71e..70f31621eef 100644 --- a/doc/administration/gitaly/troubleshooting.md +++ b/doc/administration/gitaly/troubleshooting.md @@ -576,7 +576,7 @@ To determine the primary node of a repository: Praefect node: ```shell - curl localhost:9652/metrics | grep gitaly_praefect_primaries` + curl localhost:9652/metrics | grep gitaly_praefect_primaries ``` ### View repository metadata diff --git a/doc/administration/instance_limits.md b/doc/administration/instance_limits.md index d8b2b27a969..a2fb3b7eb10 100644 --- a/doc/administration/instance_limits.md +++ b/doc/administration/instance_limits.md @@ -961,7 +961,7 @@ Reports that go over the 20 MB limit aren't loaded. Affected reports: ### Maximum file size indexed You can set a limit on the content of repository files that are indexed in -Elasticsearch. Any files larger than this limit only index the filename. +Elasticsearch. Any files larger than this limit only index the file name. The file content is neither indexed nor searchable. Setting a limit helps reduce the memory usage of the indexing processes and diff --git a/doc/administration/license_file.md b/doc/administration/license_file.md index 900dad3a369..5203707027b 100644 --- a/doc/administration/license_file.md +++ b/doc/administration/license_file.md @@ -44,7 +44,7 @@ If you have a license, you can also import it when you install GitLab. - For self-compiled installations: - Place the `Gitlab.gitlab-license` file in the `config/` directory. - - To specify a custom location and filename for the license, set the + - To specify a custom location and file name for the license, set the `GITLAB_LICENSE_FILE` environment variable with the path to the file: ```shell @@ -53,7 +53,7 @@ If you have a license, you can also import it when you install GitLab. - For Linux package installations: - Place the `Gitlab.gitlab-license` file in the `/etc/gitlab/` directory. - - To specify a custom location and filename for the license, add this entry to `gitlab.rb`: + - To specify a custom location and file name for the license, add this entry to `gitlab.rb`: ```ruby gitlab_rails['initial_license_file'] = "/path/to/license/file" diff --git a/doc/administration/logs/log_parsing.md b/doc/administration/logs/log_parsing.md index b281620fcf3..ef1de2b630b 100644 --- a/doc/administration/logs/log_parsing.md +++ b/doc/administration/logs/log_parsing.md @@ -24,7 +24,7 @@ include use cases targeted for parsing GitLab log files. ## Parsing Logs The examples listed below address their respective log files by -their relative Linux package installation paths and default filenames. +their relative Linux package installation paths and default file names. Find the respective full paths in the [GitLab logs sections](../logs/index.md#production_jsonlog). ### General Commands diff --git a/doc/administration/operations/rails_console.md b/doc/administration/operations/rails_console.md index b3e7a97428a..9ec88e2fddd 100644 --- a/doc/administration/operations/rails_console.md +++ b/doc/administration/operations/rails_console.md @@ -707,7 +707,7 @@ irb(#<Project>)> web_url The `gitlab-rails` command executes Rails Runner using a non-root account and group, by default: `git:git`. -If the non-root account cannot find the Ruby script filename passed to `gitlab-rails runner` +If the non-root account cannot find the Ruby script file name passed to `gitlab-rails runner` you may get a syntax error, not an error that the file couldn't be accessed. A common reason for this is that the script has been put in the root account's home directory. diff --git a/doc/administration/repository_storage_paths.md b/doc/administration/repository_storage_paths.md index 80871ecd478..4b7737b28e9 100644 --- a/doc/administration/repository_storage_paths.md +++ b/doc/administration/repository_storage_paths.md @@ -179,7 +179,7 @@ Files stored in an S3-compatible endpoint can have the same advantages as #### Avatars Each file is stored in a directory that matches the `id` assigned to it in the database. The -filename is always `avatar.png` for user avatars. When an avatar is replaced, the `Upload` model is +file name is always `avatar.png` for user avatars. When an avatar is replaced, the `Upload` model is destroyed and a new one takes place with a different `id`. #### CI/CD artifacts diff --git a/doc/administration/server_hooks.md b/doc/administration/server_hooks.md index a999ed23876..61ed5d751ec 100644 --- a/doc/administration/server_hooks.md +++ b/doc/administration/server_hooks.md @@ -49,7 +49,7 @@ To set server hooks for a repository: example, if the script is in Ruby the shebang is probably `#!/usr/bin/env ruby`. - To create a single server hook, create a file with a name that matches the hook type. For example, for a - `pre-receive` server hook, the filename should be `pre-receive` with no extension. + `pre-receive` server hook, the file name should be `pre-receive` with no extension. - To create many server hooks, create a directory for the hooks that matches the hook type. For example, for a `pre-receive` server hook, the directory name should be `pre-receive.d`. Put the files for the hook in that directory. @@ -84,7 +84,7 @@ To create server hooks for a repository: 1. On the file system, create a new directory in the correct location called `custom_hooks`. 1. In the new `custom_hooks` directory: - To create a single server hook, create a file with a name that matches the hook type. For example, for a - `pre-receive` server hook, the filename should be `pre-receive` with no extension. + `pre-receive` server hook, the file name should be `pre-receive` with no extension. - To create many server hooks, create a directory for the hooks that matches the hook type. For example, for a `pre-receive` server hook, the directory name should be `pre-receive.d`. Put the files for the hook in that directory. 1. **Make the server hook files executable** and ensure that they are owned by the Git user. @@ -155,7 +155,7 @@ To create a global server hook for all repositories: 1. Make the hook file executable, ensure that it's owned by the Git user, and ensure it does not match the backup file pattern (`*~`). -If the server hook code is properly implemented, it should execute when the Git hook is next triggered. Hooks are executed in alphabetical order by filename in the hook type +If the server hook code is properly implemented, it should execute when the Git hook is next triggered. Hooks are executed in alphabetical order by file name in the hook type subdirectories. ## Remove server hooks for a repository diff --git a/doc/api/discussions.md b/doc/api/discussions.md index 1e99e5e7fb0..63794030673 100644 --- a/doc/api/discussions.md +++ b/doc/api/discussions.md @@ -982,7 +982,7 @@ Parameters for multiline comments only: A line code is of the form `<SHA>_<old>_<new>`, like this: `adc83b19e793491b1c6ea0fd8b46cd9f32e292fc_5_5` -- `<SHA>` is the SHA1 hash of the filename. +- `<SHA>` is the SHA1 hash of the file name. - `<old>` is the line number before the change. - `<new>` is the line number after the change. diff --git a/doc/api/graphql/reference/index.md b/doc/api/graphql/reference/index.md index 693349cf049..d265a1cfeac 100644 --- a/doc/api/graphql/reference/index.md +++ b/doc/api/graphql/reference/index.md @@ -9115,6 +9115,29 @@ The edge type for [`CiCatalogResourceVersion`](#cicatalogresourceversion). | <a id="cicatalogresourceversionedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | | <a id="cicatalogresourceversionedgenode"></a>`node` | [`CiCatalogResourceVersion`](#cicatalogresourceversion) | The item at the end of the edge. | +#### `CiCatalogResourcesComponentConnection` + +The connection type for [`CiCatalogResourcesComponent`](#cicatalogresourcescomponent). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="cicatalogresourcescomponentconnectionedges"></a>`edges` | [`[CiCatalogResourcesComponentEdge]`](#cicatalogresourcescomponentedge) | A list of edges. | +| <a id="cicatalogresourcescomponentconnectionnodes"></a>`nodes` | [`[CiCatalogResourcesComponent]`](#cicatalogresourcescomponent) | A list of nodes. | +| <a id="cicatalogresourcescomponentconnectionpageinfo"></a>`pageInfo` | [`PageInfo!`](#pageinfo) | Information to aid in pagination. | + +#### `CiCatalogResourcesComponentEdge` + +The edge type for [`CiCatalogResourcesComponent`](#cicatalogresourcescomponent). + +##### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="cicatalogresourcescomponentedgecursor"></a>`cursor` | [`String!`](#string) | A cursor for use in pagination. | +| <a id="cicatalogresourcescomponentedgenode"></a>`node` | [`CiCatalogResourcesComponent`](#cicatalogresourcescomponent) | The item at the end of the edge. | + #### `CiConfigGroupConnection` The connection type for [`CiConfigGroup`](#ciconfiggroup). @@ -15309,12 +15332,34 @@ four standard [pagination arguments](#connection-pagination-arguments): | ---- | ---- | ----------- | | <a id="cicatalogresourceversionauthor"></a>`author` **{warning-solid}** | [`UserCore`](#usercore) | **Introduced** in 16.7. This feature is an Experiment. It can be changed or removed at any time. User that created the version. | | <a id="cicatalogresourceversioncommit"></a>`commit` **{warning-solid}** | [`Commit`](#commit) | **Introduced** in 16.7. This feature is an Experiment. It can be changed or removed at any time. Commit associated with the version. | +| <a id="cicatalogresourceversioncomponents"></a>`components` **{warning-solid}** | [`CiCatalogResourcesComponentConnection`](#cicatalogresourcescomponentconnection) | **Introduced** in 16.7. This feature is an Experiment. It can be changed or removed at any time. Components belonging to the catalog resource. | | <a id="cicatalogresourceversioncreatedat"></a>`createdAt` **{warning-solid}** | [`Time`](#time) | **Introduced** in 16.7. This feature is an Experiment. It can be changed or removed at any time. Timestamp of when the version was created. | | <a id="cicatalogresourceversionid"></a>`id` **{warning-solid}** | [`CiCatalogResourcesVersionID!`](#cicatalogresourcesversionid) | **Introduced** in 16.7. This feature is an Experiment. It can be changed or removed at any time. Global ID of the version. | | <a id="cicatalogresourceversionreleasedat"></a>`releasedAt` **{warning-solid}** | [`Time`](#time) | **Introduced** in 16.7. This feature is an Experiment. It can be changed or removed at any time. Timestamp of when the version was released. | | <a id="cicatalogresourceversiontagname"></a>`tagName` **{warning-solid}** | [`String`](#string) | **Introduced** in 16.7. This feature is an Experiment. It can be changed or removed at any time. Name of the tag associated with the version. | | <a id="cicatalogresourceversiontagpath"></a>`tagPath` **{warning-solid}** | [`String`](#string) | **Introduced** in 16.7. This feature is an Experiment. It can be changed or removed at any time. Relative web path to the tag associated with the version. | +### `CiCatalogResourcesComponent` + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="cicatalogresourcescomponentid"></a>`id` **{warning-solid}** | [`CiCatalogResourcesComponentID!`](#cicatalogresourcescomponentid) | **Introduced** in 16.7. This feature is an Experiment. It can be changed or removed at any time. ID of the component. | +| <a id="cicatalogresourcescomponentinputs"></a>`inputs` **{warning-solid}** | [`[CiCatalogResourcesComponentsInput!]`](#cicatalogresourcescomponentsinput) | **Introduced** in 16.7. This feature is an Experiment. It can be changed or removed at any time. Inputs for the component. | +| <a id="cicatalogresourcescomponentname"></a>`name` **{warning-solid}** | [`String`](#string) | **Introduced** in 16.7. This feature is an Experiment. It can be changed or removed at any time. Name of the component. | +| <a id="cicatalogresourcescomponentpath"></a>`path` **{warning-solid}** | [`String`](#string) | **Introduced** in 16.7. This feature is an Experiment. It can be changed or removed at any time. Path used to include the component. | + +### `CiCatalogResourcesComponentsInput` + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="cicatalogresourcescomponentsinputdefault"></a>`default` **{warning-solid}** | [`String`](#string) | **Introduced** in 16.7. This feature is an Experiment. It can be changed or removed at any time. Default value for the input. | +| <a id="cicatalogresourcescomponentsinputname"></a>`name` **{warning-solid}** | [`String`](#string) | **Introduced** in 16.7. This feature is an Experiment. It can be changed or removed at any time. Name of the input. | +| <a id="cicatalogresourcescomponentsinputrequired"></a>`required` **{warning-solid}** | [`Boolean`](#boolean) | **Introduced** in 16.7. This feature is an Experiment. It can be changed or removed at any time. Indicates if an input is required. | + ### `CiConfig` #### Fields @@ -31753,6 +31798,12 @@ A `CiCatalogResourceID` is a global ID. It is encoded as a string. An example `CiCatalogResourceID` is: `"gid://gitlab/Ci::Catalog::Resource/1"`. +### `CiCatalogResourcesComponentID` + +A `CiCatalogResourcesComponentID` is a global ID. It is encoded as a string. + +An example `CiCatalogResourcesComponentID` is: `"gid://gitlab/Ci::Catalog::Resources::Component/1"`. + ### `CiCatalogResourcesVersionID` A `CiCatalogResourcesVersionID` is a global ID. It is encoded as a string. diff --git a/doc/api/packages.md b/doc/api/packages.md index 80ba5480c6e..37380ae36fc 100644 --- a/doc/api/packages.md +++ b/doc/api/packages.md @@ -91,7 +91,7 @@ GET /groups/:id/packages | Attribute | Type | Required | Description | |:----------------------|:---------------|:---------|:------------| | `id` | integer/string | yes | ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). | -| `exclude_subgroups` | boolean | false | If the parameter is included as true, packages from projects from subgroups are not listed. Default is `false`. | +| `exclude_subgroups` | boolean | no | If the parameter is included as true, packages from projects from subgroups are not listed. Default is `false`. | | `order_by` | string | no | The field to use as order. One of `created_at` (default), `name`, `version`, `type`, or `project_path`. | | `sort` | string | no | The direction of the order, either `asc` (default) for ascending order or `desc` for descending order. | | `package_type` | string | no | Filter the returned packages by type. One of `conan`, `maven`, `npm`, `pypi`, `composer`, `nuget`, `helm`, or `golang`. | diff --git a/doc/api/projects.md b/doc/api/projects.md index 4095adbb7bb..5764abda7ce 100644 --- a/doc/api/projects.md +++ b/doc/api/projects.md @@ -2940,7 +2940,7 @@ POST /projects/:id/push_rule | `commit_message_negative_regex` | string | No | No commit message is allowed to match this, for example `ssh\:\/\/`. | | `commit_message_regex` | string | No | All commit messages must match this, for example `Fixed \d+\..*`. | | `deny_delete_tag` | boolean | No | Deny deleting a tag. | -| `file_name_regex` | string | No | All committed filenames must **not** match this, for example `(jar|exe)$`. | +| `file_name_regex` | string | No | All committed file names must **not** match this, for example `(jar|exe)$`. | | `max_file_size` | integer | No | Maximum file size (MB). | | `member_check` | boolean | No | Restrict commits by author (email) to existing GitLab users. | | `prevent_secrets` | boolean | No | GitLab rejects any files that are likely to contain secrets. | @@ -2964,7 +2964,7 @@ PUT /projects/:id/push_rule | `commit_message_negative_regex` | string | No | No commit message is allowed to match this, for example `ssh\:\/\/`. | | `commit_message_regex` | string | No | All commit messages must match this, for example `Fixed \d+\..*`. | | `deny_delete_tag` | boolean | No | Deny deleting a tag. | -| `file_name_regex` | string | No | All committed filenames must **not** match this, for example `(jar|exe)$`. | +| `file_name_regex` | string | No | All committed file names must **not** match this, for example `(jar|exe)$`. | | `max_file_size` | integer | No | Maximum file size (MB). | | `member_check` | boolean | No | Restrict commits by author (email) to existing GitLab users. | | `prevent_secrets` | boolean | No | GitLab rejects any files that are likely to contain secrets. | diff --git a/doc/api/search.md b/doc/api/search.md index 4a271d9ebdc..f452d7f0398 100644 --- a/doc/api/search.md +++ b/doc/api/search.md @@ -299,7 +299,7 @@ Example response: ``` NOTE: -`filename` is deprecated in favor of `path`. Both return the full path of the file inside the repository, but in the future `filename` is intended to be only the filename and not the full path. For details, see [issue 34521](https://gitlab.com/gitlab-org/gitlab/-/issues/34521). +`filename` is deprecated in favor of `path`. Both return the full path of the file inside the repository, but in the future `filename` is intended to be only the file name and not the full path. For details, see [issue 34521](https://gitlab.com/gitlab-org/gitlab/-/issues/34521). ### Scope: commits **(PREMIUM ALL)** @@ -375,7 +375,7 @@ Example response: ``` NOTE: -`filename` is deprecated in favor of `path`. Both return the full path of the file inside the repository, but in the future `filename` is intended to be only the filename and not the full path. For details, see [issue 34521](https://gitlab.com/gitlab-org/gitlab/-/issues/34521). +`filename` is deprecated in favor of `path`. Both return the full path of the file inside the repository, but in the future `filename` is intended to be only the file name and not the full path. For details, see [issue 34521](https://gitlab.com/gitlab-org/gitlab/-/issues/34521). ### Scope: notes **(PREMIUM ALL)** @@ -690,7 +690,7 @@ Example response: ``` NOTE: -`filename` is deprecated in favor of `path`. Both return the full path of the file inside the repository, but in the future `filename` is intended to be only the filename and not the full path. For details, see [issue 34521](https://gitlab.com/gitlab-org/gitlab/-/issues/34521). +`filename` is deprecated in favor of `path`. Both return the full path of the file inside the repository, but in the future `filename` is intended to be only the file name and not the full path. For details, see [issue 34521](https://gitlab.com/gitlab-org/gitlab/-/issues/34521). ### Scope: `commits` **(PREMIUM ALL)** @@ -766,7 +766,7 @@ Example response: ``` NOTE: -`filename` is deprecated in favor of `path`. Both return the full path of the file inside the repository, but in the future `filename` is intended to be only the filename and not the full path. For details, see [issue 34521](https://gitlab.com/gitlab-org/gitlab/-/issues/34521). +`filename` is deprecated in favor of `path`. Both return the full path of the file inside the repository, but in the future `filename` is intended to be only the file name and not the full path. For details, see [issue 34521](https://gitlab.com/gitlab-org/gitlab/-/issues/34521). ### Scope: `notes` **(PREMIUM ALL)** @@ -1071,12 +1071,12 @@ Filters are available for this scope: To use a filter, include it in your query. For example: `a query filename:some_name*`. You may use wildcards (`*`) to use glob matching. -Wiki blobs searches are performed on both filenames and contents. Search +Wiki blobs searches are performed on both file names and contents. Search results: -- Found in filenames are displayed before results found in contents. +- Found in file names are displayed before results found in contents. - May contain multiple matches for the same blob because the search string - might be found in both the filename and content, or might appear multiple + might be found in both the file name and content, or might appear multiple times in the content. ```shell @@ -1103,7 +1103,7 @@ Example response: ``` NOTE: -`filename` is deprecated in favor of `path`. Both return the full path of the file inside the repository, but in the future `filename` are intended to be only the filename and not the full path. For details, see [issue 34521](https://gitlab.com/gitlab-org/gitlab/-/issues/34521). +`filename` is deprecated in favor of `path`. Both return the full path of the file inside the repository, but in the future `filename` is intended to be only the file name and not the full path. For details, see [issue 34521](https://gitlab.com/gitlab-org/gitlab/-/issues/34521). ### Scope: `commits` **(PREMIUM ALL)** @@ -1155,11 +1155,11 @@ Filters are available for this scope: To use a filter, include it in your query. For example: `a query filename:some_name*`. You may use wildcards (`*`) to use glob matching. -Blobs searches are performed on both filenames and contents. Search results: +Blobs searches are performed on both file names and contents. Search results: -- Found in filenames are displayed before results found in contents. +- Found in file names are displayed before results found in contents. - May contain multiple matches for the same blob because the search string - might be found in both the filename and content, or might appear multiple + might be found in both the file name and content, or might appear multiple times in the content. ```shell diff --git a/doc/api/secure_files.md b/doc/api/secure_files.md index b3d59127fe6..27aeaf2cd5b 100644 --- a/doc/api/secure_files.md +++ b/doc/api/secure_files.md @@ -128,7 +128,7 @@ Supported attributes: | Attribute | Type | Required | Description | |-----------------|----------------|----------|-------------| | `project_id` | integer/string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | -| `name` | string | Yes | The name of the file being uploaded. The filename must be unique in the project. | +| `name` | string | Yes | The name of the file being uploaded. The file name must be unique in the project. | | `file` | file | Yes | The file being uploaded (5 MB limit). | Example request: diff --git a/doc/development/cicd/pipeline_wizard.md b/doc/development/cicd/pipeline_wizard.md index 9fb74c6ee57..0c0c0f3cc45 100644 --- a/doc/development/cicd/pipeline_wizard.md +++ b/doc/development/cicd/pipeline_wizard.md @@ -133,8 +133,7 @@ is planned to add the ability to create a MR from here. should be committed to - `default-branch` (required): The branch that will be pre-selected during the commit step. This can be changed by the user. -- `default-filename` (optional, default: `.gitlab-ci.yml`): The Filename - to be used for the file. This can be overridden in the template file. +- `default-filename` (optional, default: `.gitlab-ci.yml`): The file name to be used for the file. This can be overridden in the template file. ### Events diff --git a/doc/development/documentation/testing.md b/doc/development/documentation/testing.md index 4d15e01d6eb..62df2395fbb 100644 --- a/doc/development/documentation/testing.md +++ b/doc/development/documentation/testing.md @@ -629,8 +629,7 @@ You can disable a specific Vale linting rule or all Vale linting rules for any p document: - To disable a specific rule, add a `<!-- vale gitlab.rulename = NO -->` tag before the text, and a - `<!-- vale gitlab.rulename = YES -->` tag after the text, replacing `rulename` with the filename - of a test in the + `<!-- vale gitlab.rulename = YES -->` tag after the text, replacing `rulename` with the file name of a test in the [GitLab styles](https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/.linting/vale/styles/gitlab) directory. - To disable all Vale linting rules, add a `<!-- vale off -->` tag before the text, and a diff --git a/doc/development/testing_guide/testing_migrations_guide.md b/doc/development/testing_guide/testing_migrations_guide.md index 2e7cfe9c089..900b7333969 100644 --- a/doc/development/testing_guide/testing_migrations_guide.md +++ b/doc/development/testing_guide/testing_migrations_guide.md @@ -84,8 +84,7 @@ end ``` In some cases, you must require multiple migration files to use them in your specs. Here, there's no -pattern between your spec file and the other migration file. You can provide the migration filename -like so: +pattern between your spec file and the other migration file. You can provide the migration file name like so: ```ruby # frozen_string_literal: true diff --git a/doc/user/project/badges.md b/doc/user/project/badges.md index 39c1d228d63..0e478e2e397 100644 --- a/doc/user/project/badges.md +++ b/doc/user/project/badges.md @@ -126,26 +126,6 @@ If you set an out of range value, GitLab automatically adjusts it to the default Badges can be added to a project by Maintainers or Owners, and are visible on the project's overview page. If you find that you have to add the same badges to several projects, you may want to add them at the [group level](#group-badges). -### Add a badge to a project - -To add a new badge to a project: - -1. On the left sidebar, select **Search or go to** and find your project. -1. Select **Settings > General**. -1. Expand **Badges**. -1. Select **Add badge**. -1. Under **Link**, enter the URL that the badges should point to. -1. Under **Badge image URL**, enter the URL of the image that should be displayed. -1. Select **Add badge**. - -After adding a badge to a project, you can see the badge in the list below the form. - -### Edit or delete a project badge - -To edit a badge, select **Edit** (**{pencil}**). - -To delete a badge, select **Delete** (**{remove}**). - ### Example project badge: Pipeline Status A common project badge presents the GitLab CI pipeline status. @@ -177,26 +157,26 @@ If you need individual badges for each project, either: - Add the badge at the [project level](#project-badges). - Use [placeholders](#placeholders). -### Add a badge to a group +## View badges -To add a new badge to a group: +To view badges available in a project or group: -1. On the left sidebar, select **Search or go to** and find your group. +1. On the left sidebar, select **Search or go to** and find your project or group. 1. Select **Settings > General**. 1. Expand **Badges**. -1. Under "Link", enter the URL that the badges should point to and under - "Badge image URL" the URL of the image that should be displayed. -1. Select **Add badge**. - -After adding a badge to a group, you can see it in the list below the form. -### Edit or delete a group badge +## Add a badge -To edit a badge, select **Edit** (**{pencil}**). +To add a new badge to a project or group: -To delete a badge, select **Delete** (**{remove}**). - -Badges associated with a group can be edited or deleted only at the [group level](#group-badges). +1. On the left sidebar, select **Search or go to** and find your project or group. +1. Select **Settings > General**. +1. Expand **Badges**. +1. Select **Add badge**. +1. In the **Name** text box, enter the name of your badge. +1. In the **Link** text box, enter the URL that the badges should point to. +1. In the **Badge image URL** text box, enter the URL of the image you want to display for the badge. +1. Select **Add badge**. ## View the URL of pipeline badges @@ -283,6 +263,31 @@ To add a new badge with a custom image to a group or project: To learn how to use custom images generated through a pipeline, see the documentation on [accessing the latest job artifacts by URL](../../ci/jobs/job_artifacts.md#from-a-url). +## Edit a badge + +To edit a badge in a project or group: + +1. On the left sidebar, select **Search or go to** and find your project or group. +1. Select **Settings > General**. +1. Expand **Badges**. +1. Next to the badge you want to edit, select **Edit** (**{pencil}**). +1. Edit the **Name**, **Link**, or **Badge image URL**. +1. Select **Save changes**. + +## Delete a badge + +To delete a badge in a project or group: + +1. On the left sidebar, select **Search or go to** and find your project or group. +1. Select **Settings > General**. +1. Expand **Badges**. +1. Next to the badge you want to delete, select **Delete** (**{remove}**). +1. On the confirmation dialog, select **Delete badge**. +1. Select **Save changes**. + +NOTE: +Badges associated with a group can be edited or deleted only at the [group level](#group-badges). + ## Placeholders Both the URL a badge points to and the image URL can contain placeholders, @@ -302,9 +307,3 @@ Placeholders allow badges to expose otherwise-private information, such as the default branch or commit SHA when the project is configured to have a private repository. This behavior is intentional, as badges are intended to be used publicly. Avoid using these placeholders if the information is sensitive. - -## Configure badges through the API - -You can also configure badges via the GitLab API. As in the settings, there is -a distinction between endpoints for badges at the -[project level](../../api/project_badges.md) and [group level](../../api/group_badges.md). diff --git a/doc/user/project/merge_requests/ai_in_merge_requests.md b/doc/user/project/merge_requests/ai_in_merge_requests.md index 2b4b28dafa2..d84bd4c0c07 100644 --- a/doc/user/project/merge_requests/ai_in_merge_requests.md +++ b/doc/user/project/merge_requests/ai_in_merge_requests.md @@ -93,7 +93,7 @@ Provide feedback on this experimental feature in [issue 408994](https://gitlab.c **Data usage**: When you use this feature, the following data is sent to the large language model referenced above: - Contents of the file -- The filename +- The file name ## Generate suggested tests in merge requests @@ -118,4 +118,4 @@ Feedback on this experimental feature can be provided in [issue 408995](https:// **Data usage**: When you use this feature, the following data is sent to the large language model referenced above: - Contents of the file -- The filename +- The file name diff --git a/doc/user/project/merge_requests/creating_merge_requests.md b/doc/user/project/merge_requests/creating_merge_requests.md index 752ee1e7c40..346a10c849d 100644 --- a/doc/user/project/merge_requests/creating_merge_requests.md +++ b/doc/user/project/merge_requests/creating_merge_requests.md @@ -189,8 +189,7 @@ A merge request is created. ### Add attachments when creating a merge request by email You can add commits to a merge request by adding -patches as attachments to the email. All attachments with a filename -ending in `.patch` are considered patches and are processed +patches as attachments to the email. All attachments with a file name ending in `.patch` are considered patches and are processed ordered by name. The combined size of the patches can be 2 MB. diff --git a/doc/user/project/repository/index.md b/doc/user/project/repository/index.md index 870cfbc9148..28bd0ad7215 100644 --- a/doc/user/project/repository/index.md +++ b/doc/user/project/repository/index.md @@ -209,8 +209,7 @@ These files can either be plain text or have the extension of a > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/19515) in GitLab 12.6. -GitLab can render OpenAPI specification files. The filename -must include `openapi` or `swagger` and the extension must be `yaml`, +GitLab can render OpenAPI specification files. The file name must include `openapi` or `swagger` and the extension must be `yaml`, `yml`, or `json`. The following examples are all correct: - `openapi.yml` diff --git a/doc/user/project/repository/signed_commits/ssh.md b/doc/user/project/repository/signed_commits/ssh.md index c87a992fdac..e1c2a73be3e 100644 --- a/doc/user/project/repository/signed_commits/ssh.md +++ b/doc/user/project/repository/signed_commits/ssh.md @@ -48,8 +48,7 @@ To configure Git to use your key: git config --global gpg.format ssh ``` -1. Specify which public SSH key to use as the signing key and change the filename - (`~/.ssh/examplekey.pub`) to the location of your key. The filename might +1. Specify which public SSH key to use as the signing key and change the file name (`~/.ssh/examplekey.pub`) to the location of your key. The file name might differ, depending on how you generated your key: ```shell diff --git a/doc/user/shortcuts.md b/doc/user/shortcuts.md index e504ee90821..566af81d31b 100644 --- a/doc/user/shortcuts.md +++ b/doc/user/shortcuts.md @@ -77,7 +77,7 @@ relatively quickly to work, and they take you to another page in the project. | <kbd>g</kbd> + <kbd>n</kbd> | Go to the [repository graph](#repository-graph) page (**Code > Repository graph**). | | <kbd>g</kbd> + <kbd>d</kbd> | Go to repository charts (**Analyze > Repository analytics**). | | <kbd>g</kbd> + <kbd>i</kbd> | Go to the project issues list (**Plan > Issues**). | -| <kbd>i</kbd> | Go to the New Issue page (**Pan > Issues**, select **New issue** ). | +| <kbd>i</kbd> | Go to the New Issue page (**Plan > Issues**, select **New issue** ). | | <kbd>g</kbd> + <kbd>b</kbd> | Go to the project issue boards list (**Plan > Issue boards**). | | <kbd>g</kbd> + <kbd>m</kbd> | Go to the project [merge requests](project/merge_requests/index.md) list (**Code > Merge requests**). | | <kbd>g</kbd> + <kbd>p</kbd> | Go to the CI/CD pipelines list (**Build > Pipelines**). | |