docs: update GitLab links (5ef6abe8) · Commits · to be continuous... / Maven

.gitlab/merge_request_templates/new_feature.md

+2 −2

Original line number	Diff line number	Diff line
		@@ -8,8 +8,8 @@ Closes #999
		## Checklist

		* General:
		* [ ] use [rules](https://docs.gitlab.com/ee/ci/yaml/#rules) instead of [only/except](https://docs.gitlab.com/ee/ci/yaml/#onlyexcept-advanced)
		* [ ] optimized [cache](https://docs.gitlab.com/ee/ci/caching/) configuration (wherever applicable)
		* [ ] use [rules](https://docs.gitlab.com/ci/yaml/#rules) instead of [only/except](https://docs.gitlab.com/ci/yaml/#onlyexcept-advanced)
		* [ ] optimized [cache](https://docs.gitlab.com/ci/caching/) configuration (wherever applicable)
		* Publicly usable:
		* [ ] untagged runners
		* [ ] no proxy configuration but support `http_proxy`/`https_proxy`/`no_proxy`

CONTRIBUTING.md

+1 −1

Original line number	Diff line number	Diff line
		@@ -61,7 +61,7 @@ To contribute:

		1. Create an issue describing the bug or enhancement you want to propose (select the right issue template).
		2. Make sure the issue has been reviewed and agreed.
		3. Create a Merge Request, from your own fork (see [forking workflow](https://docs.gitlab.com/ee/user/project/repository/forking_workflow.html) documentation).
		3. Create a Merge Request, from your own fork (see [forking workflow](https://docs.gitlab.com/user/project/repository/forking_workflow/) documentation).
		Don't hesitate to mark your MR as `Draft` as long as you think it's not ready to be reviewed.

		### Git Commit Conventions

README.md

+13 −13

Original line number	Diff line number	Diff line
		@@ -4,8 +4,8 @@ This project implements a GitLab CI/CD template to build, test and analyse your

		## Usage

		This template can be used both as a [CI/CD component](https://docs.gitlab.com/ee/ci/components/#use-a-component)
		or using the legacy [`include:project`](https://docs.gitlab.com/ee/ci/yaml/index.html#includeproject) syntax.
		This template can be used both as a [CI/CD component](https://docs.gitlab.com/ci/components/#use-a-component)
		or using the legacy [`include:project`](https://docs.gitlab.com/ci/yaml/#includeproject) syntax.

		### Use as a CI/CD component

		@@ -67,7 +67,7 @@ We consider reinstalling over and over again another version of Maven in every j

		This variable is used to define the Maven configuration directory. It is used to declare the cache policy and marked the `${MAVEN_CFG_DIR}/repository` directory as cached (not to download Maven dependencies over and over again).

		If you have a good reason to do differently, you'll have to override the `MAVEN_CLI_OPTS` variable as well as the [`cache`](https://docs.gitlab.com/ee/ci/yaml/#cache) policy.
		If you have a good reason to do differently, you'll have to override the `MAVEN_CLI_OPTS` variable as well as the [`cache`](https://docs.gitlab.com/ci/yaml/#cache) policy.

		### About `$MAVEN_SETTINGS_FILE`

		@@ -76,7 +76,7 @@ If a file is found at the `$MAVEN_SETTINGS_FILE` location, the template automati
		Note that with this design you are free to either:

		1. inline the `settings.xml` file into your repository source (:warning: make sure not to inline secrets but use the `${env.MY_PASSWORD}` replacement pattern instead and define the `MY_PASSWORD` variable as secret project variable),
		2. or define the `settings.xml` content as a [file type project variable](https://docs.gitlab.com/ee/ci/variables/#use-file-type-cicd-variables).
		2. or define the `settings.xml` content as a [file type project variable](https://docs.gitlab.com/ci/variables/#use-file-type-cicd-variables).

		## Jobs

		@@ -97,7 +97,7 @@ It uses the following variable:
		With its default arguments, the GitLab CI template for Maven forces the use of [JaCoCo Maven Plugin](https://www.eclemma.org/jacoco/trunk/doc/maven.html)
		to compute code coverage during unit tests execution.

		In addition it makes the necessary to [integrate code coverage stats into your GitLab project](https://docs.gitlab.com/ee/ci/testing/code_coverage/#view-coverage-results) (report badge and viewable coverage in merge requests).
		In addition it makes the necessary to [integrate code coverage stats into your GitLab project](https://docs.gitlab.com/ci/testing/code_coverage/#view-coverage-results) (report badge and viewable coverage in merge requests).

		If you want to fix the JaCoCo plugin version or tweak the default configuration, you may have to configure the
		[JaCoCo Maven Plugin](https://www.eclemma.org/jacoco/trunk/doc/maven.html) in your `pom.xml`, but be aware of the
		@@ -107,7 +107,7 @@ following:
		unit tests (not necessarily with the expected configuration). If you really need to do so anyway, you'll have to
		override the `$MAVEN_BUILD_ARGS` variable to remove the explicit invocation to JaCoCo goals.
		* make sure the `report` goal computes a CSV report (that's default behavior), that is used by the Maven template to compute the global coverage stat,
		* make sure the `report` goal computes an XML report (that's default behavior), that is required to support [GitLab code coverage intergation](https://docs.gitlab.com/ee/ci/testing/test_coverage_visualization/jacoco.html).
		* make sure the `report` goal computes an XML report (that's default behavior), that is required to support [GitLab code coverage intergation](https://docs.gitlab.com/ci/testing/code_coverage/jacoco/).

		More info:

		@@ -162,7 +162,7 @@ from GitLab's environment variables.
		:warning: This feature also depends on your SonarQube server version and license.
		If using Community Edition, you'll have to install the [sonarqube-community-branch-plugin](https://github.com/mc1arke/sonarqube-community-branch-plugin) to enable automatic Branch & Merge Request analysis (only works from SonarQube version 8).

		:warning: Merge Request Analysis only works if you're running [Merge Request pipeline](https://docs.gitlab.com/ee/ci/yaml/workflow.html#switch-between-branch-pipelines-and-merge-request-pipelines) strategy (default).
		:warning: Merge Request Analysis only works if you're running [Merge Request pipeline](https://docs.gitlab.com/ci/yaml/workflow/#switch-between-branch-pipelines-and-merge-request-pipelines) strategy (default).

		#### Disable the job

		@@ -328,11 +328,11 @@ Your Maven repository may require authentication credentials to publish artifact

		You may handle them in the following ways:

		1. define all required credentials as :lock: [project variables](https://docs.gitlab.com/ee/ci/variables/#for-a-project),
		1. define all required credentials as :lock: [project variables](https://docs.gitlab.com/ci/variables/#for-a-project),
		2. make sure your `pom.xml` (or ancestor) [declares your `<repository>` and `<snapshotRepository>` with server ids in a `<distributionManagement>` section](https://maven.apache.org/pom.html#repository),
		3. in your `${MAVEN_CFG_DIR}/settings.xml` file, [define the repository servers credentials in the `<servers>` section](https://maven.apache.org/settings.html#Servers) using the `${env.VARIABLE}` pattern—will be automatically evaluated and replaced by Maven.

		Example 1 — using the [GitLab Maven Repository](https://docs.gitlab.com/ee/user/packages/maven_repository/)
		Example 1 — using the [GitLab Maven Repository](https://docs.gitlab.com/user/packages/maven_repository/)

		`pom.xml`:

		@@ -357,7 +357,7 @@ You may handle them in the following ways:
		<settings>
		<servers>
		<!-- required when using GitLab's package registry to deploy -->
		<!-- see: https://docs.gitlab.com/ee/user/packages/maven_repository/index.html#use-the-gitlab-endpoint-for-maven-packages -->
		<!-- see: https://docs.gitlab.com/user/packages/maven_repository/index/#use-the-gitlab-endpoint-for-maven-packages -->
		<server>
		<id>gitlab-maven</id>
		<configuration>
		@@ -422,9 +422,9 @@ You can either use an `ssh` key or an authenticated and authorized Git user.

		##### Using an SSH key

		We recommend you to use a [project deploy key](https://docs.gitlab.com/ee/user/project/deploy_keys/#project-deploy-keys) with write access to your project.
		We recommend you to use a [project deploy key](https://docs.gitlab.com/user/project/deploy_keys/#project-deploy-keys) with write access to your project.

		The key should not have a passphrase (see [how to generate a new SSH key pair](https://docs.gitlab.com/ee/user/ssh.html#generate-an-ssh-key-pair)).
		The key should not have a passphrase (see [how to generate a new SSH key pair](https://docs.gitlab.com/user/ssh/#generate-an-ssh-key-pair)).

		Specify :lock: `$GIT_PRIVATE_KEY` as protected project variable with the private part of the deploy key.

		@@ -567,7 +567,7 @@ In order to be able to communicate with the Vault server, the variant requires t
		\| :lock: `VAULT_ROLE_ID` \| The [AppRole](https://www.vaultproject.io/docs/auth/approle) RoleID \| _none_ \|
		\| :lock: `VAULT_SECRET_ID` \| The [AppRole](https://www.vaultproject.io/docs/auth/approle) SecretID \| _none_ \|

		By default, the variant will authentifacte using a [JWT ID token](https://docs.gitlab.com/ee/ci/secrets/id_token_authentication.html). To use [AppRole](https://www.vaultproject.io/docs/auth/approle) instead the `VAULT_ROLE_ID` and `VAULT_SECRET_ID` should be defined as secret project variables.
		By default, the variant will authentifacte using a [JWT ID token](https://docs.gitlab.com/ci/secrets/id_token_authentication/). To use [AppRole](https://www.vaultproject.io/docs/auth/approle) instead the `VAULT_ROLE_ID` and `VAULT_SECRET_ID` should be defined as secret project variables.

		#### Usage