diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2023-05-22 21:10:38 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2023-05-22 21:10:38 +0300 |
commit | 7e2f555a6dc37839727dee130d8ed4421b680d42 (patch) | |
tree | f2bcca7814bbaa6ee50e14830bc3a74307b1148e /doc/user | |
parent | 4ec96676406da695de083b4f394290902da2a964 (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/user')
-rw-r--r-- | doc/user/asciidoc.md | 11 | ||||
-rw-r--r-- | doc/user/project/changelogs.md | 91 | ||||
-rw-r--r-- | doc/user/project/description_templates.md | 4 | ||||
-rw-r--r-- | doc/user/project/web_ide/index.md | 47 |
4 files changed, 102 insertions, 51 deletions
diff --git a/doc/user/asciidoc.md b/doc/user/asciidoc.md index 6b642363dd6..f04fece7b76 100644 --- a/doc/user/asciidoc.md +++ b/doc/user/asciidoc.md @@ -244,9 +244,6 @@ pages, change the filename from `.adoc` to `.asciidoc`. ```plaintext include::basics.adoc[] - -// define -a allow-uri-read to allow content to be read from URI -include::https://example.org/installation.adoc[] ``` To guarantee good system performance and prevent malicious documents from causing @@ -254,6 +251,14 @@ problems, GitLab enforces a maximum limit on the number of include directives processed in any one document. You can include up to 32 documents, which is inclusive of transitive dependencies. +To use includes from separate pages or external URLs, enable the `allow-uri-read` +in [application settings](../administration/wikis/index.md#allow-uri-includes-for-asciidoc). + +```plaintext +// define application setting allow-uri-read to true to allow content to be read from URI +include::https://example.org/installation.adoc[] +``` + ### Blocks ```plaintext diff --git a/doc/user/project/changelogs.md b/doc/user/project/changelogs.md index 7e622110291..0c12f7d476b 100644 --- a/doc/user/project/changelogs.md +++ b/doc/user/project/changelogs.md @@ -56,41 +56,56 @@ Changelog: feature ## Create a changelog -To generate changelog data based on commits in a repository, see +Changelogs are generated from the command line, using either the API or the +GitLab CLI. The changelog output is formatted in Markdown, and +[you can customize it](#customize-the-changelog-output). + +### From the API + +To generate changelogs via the API with a `curl` command, see [Add changelog data to a changelog file](../../api/repositories.md#add-changelog-data-to-a-changelog-file) in the API documentation. -The changelog output is formatted in Markdown, and [you can customize it](#customize-the-changelog-output). +### From the GitLab CLI -### Reverted commits +> [Introduced](https://gitlab.com/gitlab-org/cli/-/merge_requests/1222) in `glab` version 1.30.0. -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/55537) in GitLab 13.10. +Prerequisites: -To be treated as a revert commit, the commit message must contain the string -`This reverts commit <SHA>`, where `SHA` is the SHA of the commit to be reverted. +- You have installed and configured the [GitLab CLI](../../integration/glab/index.md), + version 1.30.0 or later. +- Your repository's tag naming schema matches + [the expected tag naming format](#customize-the-tag-format-when-extracting-versions). +- Commits include [changelog trailers](../../development/changelog.md). -When generating a changelog for a range, GitLab ignores commits both added and -reverted in that range. In this example, commit C reverts commit B. Because -commit C has no other trailer, only commit A is added to the changelog: +To generate the changelog: -```mermaid -graph LR - A[Commit A<br>Changelog: changed] --> B[Commit B<br>Changelog: changed] - B --> C[Commit C<br>Reverts commit B] -``` +1. Update your local copy of your repository with `git fetch`. +1. To generate a changelog for the current version (as determined by `git describe --tags`) + with the default options: + - Run the command `glab changelog generate`. + - To save the output to a file, run the command `glab changelog generate > <filename>.md`. +1. To generate a changelog with customized options, run the command `glab changelog generate` + and append your desired options. Some options include: -However, if the revert commit (commit C) _also_ contains a changelog trailer, -both commits A and C are included in the changelog: - -```mermaid -graph LR - A[Commit A<br><br>Changelog: changed] --> B[Commit B<br><br>Changelog: changed] - B --> C[Commit C<br>Reverts commit B<br>Changelog: changed] -``` + - `--config-file [string]`: The path to the changelog configuration file in your project's + Git repository. Defaults to `.gitlab/changelog_config.yml`. + - Commit range: + - `--from [string]`: The start of the range of commits (as a SHA) to use for + generating the changelog. This commit itself isn't included in the changelog. + - `--to [string]`: The end of the range of commits (as a SHA) to use for + generating the changelog. This commit _is_ included in the list. Defaults to the `HEAD` + of the default project branch. + - `--date [string]`: The date and time of the release, in ISO 8601 (`2016-03-11T03:45:40Z`) + format. Defaults to the current time. + - `--trailer [string]`: The Git trailer to use for including commits. Defaults to `Changelog`. + - `--version [string]`: The version to generate the changelog for. -Commit B is skipped. +To learn more about the parameters available in GitLab CLI, run `glab changelog generate --help`. See the +[API documentation](../../api/repositories.md#add-changelog-data-to-a-changelog-file) +for definitions and usage. -### Customize the changelog output +## Customize the changelog output To customize the changelog output, edit the changelog configuration file. The default location for this configuration is `.gitlab/changelog_config.yml`. The file supports @@ -311,6 +326,34 @@ To test if your regular expression is working, you can use websites such as [regex101](https://regex101.com/). If the regular expression syntax is invalid, an error is produced when generating a changelog. +## Reverted commit handling + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/55537) in GitLab 13.10. + +To be treated as a revert commit, the commit message must contain the string +`This reverts commit <SHA>`, where `SHA` is the SHA of the commit to be reverted. + +When generating a changelog for a range, GitLab ignores commits both added and +reverted in that range. In this example, commit C reverts commit B. Because +commit C has no other trailer, only commit A is added to the changelog: + +```mermaid +graph LR + A[Commit A<br>Changelog: changed] --> B[Commit B<br>Changelog: changed] + B --> C[Commit C<br>Reverts commit B] +``` + +However, if the revert commit (commit C) _also_ contains a changelog trailer, +both commits A and C are included in the changelog: + +```mermaid +graph LR + A[Commit A<br><br>Changelog: changed] --> B[Commit B<br><br>Changelog: changed] + B --> C[Commit C<br>Reverts commit B<br>Changelog: changed] +``` + +Commit B is skipped. + ## Related topics - [Changelog-related endpoints](../../api/repositories.md) in the Repositories API diff --git a/doc/user/project/description_templates.md b/doc/user/project/description_templates.md index f0ced95c8eb..551888d1875 100644 --- a/doc/user/project/description_templates.md +++ b/doc/user/project/description_templates.md @@ -118,8 +118,8 @@ that you can use when creating a new project in the instance. > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/52360) in GitLab 13.9. > - [Feature flag removed](https://gitlab.com/gitlab-org/gitlab/-/issues/321247) in GitLab 14.0. -With **group-level** description templates, you can store your templates in a single repository and -configure the group file templates setting to point to that repository. +With **group-level** description templates, you can select a repository within the group to store +your templates. Then, you can access these templates from other projects in the group. As a result, you can use the same templates in issues and merge requests in all the group's projects. To re-use templates [you've created](../project/description_templates.md#create-an-issue-template): diff --git a/doc/user/project/web_ide/index.md b/doc/user/project/web_ide/index.md index 18721c0582d..530b1f5463c 100644 --- a/doc/user/project/web_ide/index.md +++ b/doc/user/project/web_ide/index.md @@ -89,17 +89,17 @@ For more information, see the [VS Code documentation](https://code.visualstudio. ## Upload a new file -To upload a new file and add it to the Git repository: +To upload a new file in the Web IDE: -1. In the **Explorer** file tree, navigate to the directory where you want to upload the file. -1. Optional. If the directory does not exist yet, select the directory path where you want to have a new directory and either: - - Right-click on the directory path, and select **New Folder...**. You can create a nested directory path with the `/` separator, for example `parentdir/subdir1/subdir2`. - - In the **Explorer** panel, in the upper-right corner, select the new folder (**{folder-new}**) icon. -1. Enter the name of the new directory, and press <kbd>Enter/Return</kbd> to create it. -1. Right-click on the directory path and select `Upload...`. -1. Select the file you want to upload, then select `Open`. You can select and add multiple files at once. +1. On the activity bar on the left, select **Explorer** and go to the directory where you want to upload the file. +1. Optional. For a new directory, go to the path where you want to have the directory and do one of the following: + - Right-click the path, and select **New Folder...**. You can create a nested path with `/` (for example, `parentdir/subdir1/subdir2`). + - In the upper right of the **Explorer** panel, select **New Folder...** (**{folder-new}**). +1. Enter the name of the new directory, and press <kbd>Enter</kbd>. +1. Right-click the path, and select **Upload...**. +1. Select the file you want to upload, then select **Open**. You can upload multiple files at once. -The file is uploaded and automatically added as a new file to the Git repository. +The new file is uploaded and automatically added to the repository. ## Switch branches @@ -129,17 +129,17 @@ To commit changes in the Web IDE: or press <kbd>Control</kbd>+<kbd>Shift</kbd>+<kbd>G</kbd>. 1. Enter your commit message. 1. Select **Commit & Push**. -1. Commit to the current branch, or create a new branch. +1. Commit to the current branch, or [create a new branch](#create-a-branch). ## Create a merge request -To create a merge request: +To create a merge request in the Web IDE: -1. [Commit the changes](index.md#commit-changes). -1. In the pop-up notification in the lower-right corner, select `Create Merge Request`. -This action opens a new window with the [merge request creation form](../merge_requests/index.md). +1. [Commit the changes](#commit-changes). +1. In the pop-up notification in the lower-right corner, select **Create Merge Request**. + A new window opens for you to create the [merge request](../merge_requests/index.md). -To access missed notifications, see the [IDE notification tips](index.md#access-missed-ide-notifications). +To access missed notifications, see [Access notifications](#access-notifications). ## Use the command palette @@ -188,6 +188,13 @@ To change the Web IDE theme: The active color theme is stored in the [user settings](#edit-settings). +## Access notifications + +When you perform actions in the Web IDE, notifications appear in the lower-right corner. To access missed notifications: + +1. On the status bar, in the lower-right corner, select the bell (**{notifications}**) for a list of notifications. +1. Select the notification you want to access. + <!-- ## Privacy and data collection for extensions The Web IDE Extension Marketplace is based on Open VSX. Open VSX does not collect any @@ -204,6 +211,9 @@ To protect your privacy and data: ## Interactive web terminals for the Web IDE (Beta) +WARNING: +This feature is in [Beta](../../../policy/alpha-beta-support.md#beta) and subject to change without notice. + When you set up a remote development server in the Web IDE, you can use interactive web terminals to: - Access a remote shell on the server. @@ -213,10 +223,3 @@ You cannot use interactive web terminals to interact with a runner. However, you can use a terminal to install dependencies and compile and debug code. For more information about configuring a workspace that supports interactive web terminals, see [remote development](../remote_development/index.md). - -## Access missed IDE notifications - -Actions that you take in the Web IDE trigger notifications that pop up in the lower-right corner. If you missed the pop-up: - -1. In the lower-right corner, select the bell icon (**{notifications}**). This opens a list of notifications. -1. Select the notification you want to access. |