// Copyright (C) 2023 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only

/*!
    \page creator-vcs-gitlab.html
    \previouspage creator-reference.html

    \ingroup creator-reference-vcs

    \title GitLab

    \brief Additional GitLab functions.

    GitLab is a DevOps tool developed by GitLab. You can clone projects from
    GitLab servers and use \l{Using Git} to manage your local and remote
    repositories.

    To use GitLab, create a connection to the GitLab server and clone the
    projects you want to work on. Link previously cloned projects to GitLab
    in the project settings to receive event notifications in the
    \l {View output}{Version Control} view.

    \note Enable the GitLab plugin to use it.

    \section1 Connecting to GitLab servers

    To connect to a GitLab server, specify the server host name and
    port number, as well as an access token that you create in GitLab for \QC.
    The permission scope of the token must be at least \c read_api or \c api.

    To specify connections to GitLab servers, go to \preferences >
    \uicontrol {Version Control} > \uicontrol GitLab:

    \image {qtcreator-gitlab-preferences.png} {GitLab tab in Version Control preferences}

    To add GitLab servers:

    \list 1
        \li Select \uicontrol Add to open the \uicontrol {Add Server} dialog.
            \image {qtcreator-gitlab-preferences-add-server.png} {Add Server dialog}
        \li In \uicontrol Host, enter the host name of the GitLab server.
        \li In \uicontrol Description, enter a free-form text that is displayed
            in the GitLab settings of a linked project.
        \li In \uicontrol {Access token}, enter the access token you created for
            \QC in the GitLab server, in \uicontrol Preferences >
            \uicontrol {Access Tokens}.
        \li In \uicontrol Port, enter a port number.
        \li Clear \uicontrol HTTPS to use an HTTP connection instead of a secure
            connection.
        \li Select \uicontrol Add to create the connection.
    \endlist

    In the \uicontrol GitLab tab, \uicontrol curl displays the path to the
    \c curl tool used for HTTP connections. Specify another path to
    use another instance of the tool than the one \QC found.

    To edit the selected connection, select \uicontrol Edit.

    To remove the selected connection, select \uicontrol Remove.

    \section1 Cloning projects

    You can clone projects from the connected GitLab servers. \QC reads your
    user name and ID from the access token and displays the available projects
    in each server. You can search for a particular project or browse projects
    in the list.

    To clone projects from GitLab:

    \list 1
        \li Go to \uicontrol Tools > \uicontrol GitLab to view a list of
            connected GitLab servers and available projects in each server.
            \image {qtcreator-gitlab-project-list.png} {GitLab dialog}
        \li In \uicontrol Remote, select a GitLab server.
        \li In \uicontrol Projects, select the project to clone.
        \li Select \uicontrol Clone to open the \uicontrol {Clone Repository}
            dialog.
            \image {qtcreator-gitlab-clone-repository.png} {Clone Repository dialog}
        \li In \uicontrol Repository, specify the URL of the repository.
        \li In \uicontrol Path, specify the path where to clone the repository.
        \li In \uicontrol Directory, specify the name of the directory for the
            cloned repository.
        \li Select \uicontrol Recursive to also clone submodules of the
            repository.
        \li Select \uicontrol Clone to clone the project to the specified
            directory.
    \endlist

    \QC automatically opens the project. If the cloned project has several
    project files (such as \c CMakeList.txt, \c .pro, and \c .qbs), \QC prompts you to
    select the one to open. If it does not have a project file that \QC can
    open, go to \uicontrol File > \uicontrol {New Project} >
    \uicontrol {Import Project} > \uicontrol {Import Existing Project} and
    import the project as a generic project.

    \sa {Enable and disable plugins}, {Link projects with GitLab},
    {Set up version control systems}, {Use common VCS functions},
    {Use project wizards}, {Version Control Systems}, {Using Git}
*/

/*!
    \page creator-how-to-link-with-gitlab.html
    \previouspage creator-how-tos.html

    \ingroup creator-how-to-projects-configure

    \title Link projects with GitLab

    Link a project with a GitLab token to receive notifications on events, such
    as merge requests, issues, or comments, in the \uicontrol {Version Control}
    pane. The information is fetched every 15 minutes. Only events that occurred
    after the last time you logged into GitLab are displayed when you open the
    project for the first time. Subsequently, events that occurred after the last
    successful fetch are listed.

    To link with GitLab:

    \list 1
        \li Go to \uicontrol Projects > \uicontrol {Project Settings} >
            \uicontrol {GitLab} to view the GitLab settings for the currently
            active project.
            \image {qtcreator-gitlab-preferences-project.png} {GitLab settings for a project}
        \li In \uicontrol Host, select the URL of the GitLab server.
        \li In \uicontrol {Linked GitLab configuration}, select the GitLab
            server settings to use.
        \li Select \uicontrol {Link with GitLab} to receive event notifications
            in the \uicontrol {Version Control} pane.
    \endlist

    To test the connection to the host using the access token specified in the
    GitLab configuration, select \uicontrol {Test Connection}.

    To stop the reception of event notifications, select
    \uicontrol {Unlink from GitLab}.

    \sa {Enable and disable plugins}, {Set up version control systems},
    {Use common VCS functions}, {Building and running projects}, {Version Control Systems},
    {Using Git}, {GitLab}
*/
