Welcome to mirror list, hosted at ThFree Co, Russian Federation.

gitlab.com/gitlab-org/gitlab-foss.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGitLab Bot <gitlab-bot@gitlab.com>2024-01-10 21:07:52 +0300
committerGitLab Bot <gitlab-bot@gitlab.com>2024-01-10 21:07:52 +0300
commit9dbe80c7d52d682aaf431790d9011d7c2912b85c (patch)
tree4d29f537133f2fc952858f6e7439a6cce13c41bc /doc/integration
parente1d966e6543433479a932e1e29ad538cd587699a (diff)
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/integration')
-rw-r--r--doc/integration/diffblue-cover.md92
-rw-r--r--doc/integration/diffblue_cover.md89
2 files changed, 96 insertions, 85 deletions
diff --git a/doc/integration/diffblue-cover.md b/doc/integration/diffblue-cover.md
index bd1d026b5ef..fb181f8e95d 100644
--- a/doc/integration/diffblue-cover.md
+++ b/doc/integration/diffblue-cover.md
@@ -1,89 +1,11 @@
---
-stage: Verify
-group: Pipeline Execution
-info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments"
-description: >-
- How to configure the Diffblue Cover GitLab integration - Cover Pipeline for
- GitLab
+redirect_to: 'diffblue_cover.md'
+remove_date: '2024-01-10'
---
-# Diffblue Cover **(FREE ALL)**
+This document was moved to [another location](diffblue_cover.md).
-You can integrate the [Diffblue Cover](https://www.diffblue.com/) reinforcement learning AI tool into your CI/CD pipelines, to automatically write and maintain Java unit tests for your GitLab projects.
-The Diffblue Cover Pipeline for GitLab integration allows you to automatically:
-
-- Write a baseline unit test suite for your projects.
-- Write new unit tests for new code.
-- Update existing unit tests in your code.
-- Remove existing unit tests in your code when they're no longer required.
-
-![Cover Pipeline for GitLab Basic MR Process](img/diffblue_cover_workflow_after_v16_8.png)
-
-## Configure the integration
-
-To integrate Diffblue Cover into your pipeline:
-
-1. Find and configure the Diffblue Cover integration.
-1. Configure a pipeline for a sample project using the GitLab pipeline editor and the Diffblue Cover pipeline template.
-1. Create a full baseline unit test suite for the project.
-
-### Configure Diffblue Cover
-
-1. On the left sidebar, select **Search or go to** and find your project.
- - If you want to test the integration with a sample project, you can [import](../user/project/import/repo_by_url.md)
- the Diffblue [Spring PetClinic sample project](https://github.com/diffblue/demo-spring-petclinic).
-1. Select **Settings > Integrations**.
-1. Find **Diffblue Cover** and select **Configure**.
-1. Complete the fields:
-
- - Select the **Active** checkbox.
- - Enter your Diffblue Cover **License key** provided in your welcome email or by your organization.
- If needed, select the [**Try Diffblue Cover**](https://www.diffblue.com/try-cover/gitlab) link to sign up for a free trial.
- - Enter details of your GitLab access token (**Name** and **Secret**) to allow Diffblue Cover to access your project.
- In general, use a GitLab [project access token](../user/project/settings/project_access_tokens.md) with the `Developer` role, plus `api` and `write_repository` scopes.
- If necessary you can use a [group access token](../user/group/settings/group_access_tokens.md) or a [personal access token](../user/profile/personal_access_tokens.md), again with the `Developer` role, plus `api` and `write_repository` scopes.
-
- NOTE:
- Using an access token with excessive permissions is a security risk.
- If you use a Personal access token, consider creating a dedicated user with access limited to just the project, minimizing the impact of the token being leaked.
-
-1. Select **Save changes**.
- Your Diffblue Cover integration is now <mark style="color:green;">**Active**</mark> and ready for use in your project.
-
-### Configure a pipeline
-
-Here we'll create a merge request pipeline for the project that will download the latest version of Diffblue Cover, build the project, write Java unit tests for the project, and commit the changes to the branch.
-
-1. On the left sidebar, select **Search or go to** and find your project.
-1. Select **Build > Pipeline editor**.
-1. Select **Configure pipeline** to create the `.gitlab-ci.yml` file.
-1. Select **Browse templates** and find the `Diffblue-Cover.gitlab-ci.yml` template file.
-1. Select the file and copy the contents to your project's `.gitlab-ci.yml` file.
-
- NOTE:
- When using the Diffblue Cover pipeline template with your own project and existing pipeline file, add the Diffblue template content to your file and modify as needed.
- For more information, see [Cover Pipeline for GitLab](https://docs.diffblue.com/features/cover-pipeline/cover-pipeline-for-gitlab) in the Diffblue documentation.
-
-1. Enter a commit message.
-1. Enter a new **Branch** name. For example, `add-diffblue-cover-pipeline`.
-1. Select **Start a new merge request with these changes**.
-1. Select **Commit changes**.
-
-### Create a baseline unit test suite
-
-1. In the **New merge request** form, enter a **Title** (for example, "Add Cover pipeline and create baseline unit test suite") and fill out the other fields.
-1. Select **Create merge request**. The merge request pipeline runs Diffblue Cover to create the baseline unit test suite for the project.
-1. Once the pipeline completes, the changes can be reviewed from the **Changes** tab. When you're happy, merge the updates to your repo. Go to the `src/test` folders in the project repository to see the unit tests created by Diffblue Cover (suffixed with `*DiffblueTest.java`).
-
-## Subsequent code changes
-
-When performing subsequent code changes to a project, the merge request pipeline will run Diffblue Cover but will only update the associated tests.
-The resulting diff can then be analyzed to check the new behavior, catch regressions, and spot any unplanned behavioral changes to the code.
-
-![Code Change Diff](img/diffblue_cover_diff_v16_8.png)
-
-## Next steps
-
-This topic demonstrates some of the key features of Cover Pipeline for GitLab and how to use the integration in a pipeline.
-The wider and deeper functionality, provided through `dcover` commands in the pipeline template, can be implemented to expand your unit test capabilities even further.
-For more information, see [Cover Pipeline for GitLab](https://docs.diffblue.com/features/cover-pipeline/cover-pipeline-for-gitlab) in the Diffblue documentation.
+<!-- This redirect file can be deleted after <2024-01-10>. -->
+<!-- Redirects that point to other docs in the same project expire in three months. -->
+<!-- Redirects that point to docs in a different project or site (link is not relative and starts with `https:`) expire in one year. -->
+<!-- Before deletion, see: https://docs.gitlab.com/ee/development/documentation/redirects.html -->
diff --git a/doc/integration/diffblue_cover.md b/doc/integration/diffblue_cover.md
new file mode 100644
index 00000000000..bd1d026b5ef
--- /dev/null
+++ b/doc/integration/diffblue_cover.md
@@ -0,0 +1,89 @@
+---
+stage: Verify
+group: Pipeline Execution
+info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments"
+description: >-
+ How to configure the Diffblue Cover GitLab integration - Cover Pipeline for
+ GitLab
+---
+
+# Diffblue Cover **(FREE ALL)**
+
+You can integrate the [Diffblue Cover](https://www.diffblue.com/) reinforcement learning AI tool into your CI/CD pipelines, to automatically write and maintain Java unit tests for your GitLab projects.
+The Diffblue Cover Pipeline for GitLab integration allows you to automatically:
+
+- Write a baseline unit test suite for your projects.
+- Write new unit tests for new code.
+- Update existing unit tests in your code.
+- Remove existing unit tests in your code when they're no longer required.
+
+![Cover Pipeline for GitLab Basic MR Process](img/diffblue_cover_workflow_after_v16_8.png)
+
+## Configure the integration
+
+To integrate Diffblue Cover into your pipeline:
+
+1. Find and configure the Diffblue Cover integration.
+1. Configure a pipeline for a sample project using the GitLab pipeline editor and the Diffblue Cover pipeline template.
+1. Create a full baseline unit test suite for the project.
+
+### Configure Diffblue Cover
+
+1. On the left sidebar, select **Search or go to** and find your project.
+ - If you want to test the integration with a sample project, you can [import](../user/project/import/repo_by_url.md)
+ the Diffblue [Spring PetClinic sample project](https://github.com/diffblue/demo-spring-petclinic).
+1. Select **Settings > Integrations**.
+1. Find **Diffblue Cover** and select **Configure**.
+1. Complete the fields:
+
+ - Select the **Active** checkbox.
+ - Enter your Diffblue Cover **License key** provided in your welcome email or by your organization.
+ If needed, select the [**Try Diffblue Cover**](https://www.diffblue.com/try-cover/gitlab) link to sign up for a free trial.
+ - Enter details of your GitLab access token (**Name** and **Secret**) to allow Diffblue Cover to access your project.
+ In general, use a GitLab [project access token](../user/project/settings/project_access_tokens.md) with the `Developer` role, plus `api` and `write_repository` scopes.
+ If necessary you can use a [group access token](../user/group/settings/group_access_tokens.md) or a [personal access token](../user/profile/personal_access_tokens.md), again with the `Developer` role, plus `api` and `write_repository` scopes.
+
+ NOTE:
+ Using an access token with excessive permissions is a security risk.
+ If you use a Personal access token, consider creating a dedicated user with access limited to just the project, minimizing the impact of the token being leaked.
+
+1. Select **Save changes**.
+ Your Diffblue Cover integration is now <mark style="color:green;">**Active**</mark> and ready for use in your project.
+
+### Configure a pipeline
+
+Here we'll create a merge request pipeline for the project that will download the latest version of Diffblue Cover, build the project, write Java unit tests for the project, and commit the changes to the branch.
+
+1. On the left sidebar, select **Search or go to** and find your project.
+1. Select **Build > Pipeline editor**.
+1. Select **Configure pipeline** to create the `.gitlab-ci.yml` file.
+1. Select **Browse templates** and find the `Diffblue-Cover.gitlab-ci.yml` template file.
+1. Select the file and copy the contents to your project's `.gitlab-ci.yml` file.
+
+ NOTE:
+ When using the Diffblue Cover pipeline template with your own project and existing pipeline file, add the Diffblue template content to your file and modify as needed.
+ For more information, see [Cover Pipeline for GitLab](https://docs.diffblue.com/features/cover-pipeline/cover-pipeline-for-gitlab) in the Diffblue documentation.
+
+1. Enter a commit message.
+1. Enter a new **Branch** name. For example, `add-diffblue-cover-pipeline`.
+1. Select **Start a new merge request with these changes**.
+1. Select **Commit changes**.
+
+### Create a baseline unit test suite
+
+1. In the **New merge request** form, enter a **Title** (for example, "Add Cover pipeline and create baseline unit test suite") and fill out the other fields.
+1. Select **Create merge request**. The merge request pipeline runs Diffblue Cover to create the baseline unit test suite for the project.
+1. Once the pipeline completes, the changes can be reviewed from the **Changes** tab. When you're happy, merge the updates to your repo. Go to the `src/test` folders in the project repository to see the unit tests created by Diffblue Cover (suffixed with `*DiffblueTest.java`).
+
+## Subsequent code changes
+
+When performing subsequent code changes to a project, the merge request pipeline will run Diffblue Cover but will only update the associated tests.
+The resulting diff can then be analyzed to check the new behavior, catch regressions, and spot any unplanned behavioral changes to the code.
+
+![Code Change Diff](img/diffblue_cover_diff_v16_8.png)
+
+## Next steps
+
+This topic demonstrates some of the key features of Cover Pipeline for GitLab and how to use the integration in a pipeline.
+The wider and deeper functionality, provided through `dcover` commands in the pipeline template, can be implemented to expand your unit test capabilities even further.
+For more information, see [Cover Pipeline for GitLab](https://docs.diffblue.com/features/cover-pipeline/cover-pipeline-for-gitlab) in the Diffblue documentation.