Commit 2b75c6c0 authored by Pierre Smeyers's avatar Pierre Smeyers
Browse files

docs: update GitLab links

parent 4a4d3485
Loading
Loading
Loading
Loading
Loading
+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`
+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
+12 −12
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

@@ -103,7 +103,7 @@ To be able to launch unit tests with Angular CLI, the Angular template requires
image `NG_CLI_IMAGE` (it is the case with the default image, [docker-ng-cli-karma](https://github.com/trion-development/docker-ng-cli-karma)).

The following chapters detail the required configuration (depending on the unit testing framework you're using) in
order to integrate your [unit tests reports](https://docs.gitlab.com/ee/ci/testing/unit_test_reports.html) and [code coverage reports](https://docs.gitlab.com/ee/ci/testing/test_coverage_visualization.html) to GitLab.
order to integrate your [unit tests reports](https://docs.gitlab.com/ci/testing/unit_test_reports/) and [code coverage reports](https://docs.gitlab.com/ci/testing/code_coverage/) to GitLab.

Additionally, if also using SonarQube, you'll have to enable some extra reporters.

@@ -115,15 +115,15 @@ Here is the required configuration if you're using [Karma](https://karma-runner.

| Reporter                                                                                                                              | Needs `npm install` | Expected report file                | Usage                                                                                                                                                                  |
| ------------------------------------------------------------------------------------------------------------------------------------- | ------------------- | ----------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [karma-junit-reporter](https://github.com/karma-runner/karma-junit-reporter)                                                          | Yes                 | `reports/ng-test.xunit.xml`         | [GitLab unit tests integration](https://docs.gitlab.com/ee/ci/testing/unit_test_reports.html) _(JUnit format)_                                                         |
| [karma-coverage text-summary reporter](https://github.com/karma-runner/karma-coverage?tab=readme-ov-file#advanced-multiple-reporters) | No                  | N/A _(stdout)_                      | [GitLab MR test coverage results](https://docs.gitlab.com/ee/ci/testing/code_coverage/#view-coverage-results) _(GitLab grabs coverage from stdout)_ |
| [karma-coverage cobertura reporter](https://github.com/karma-runner/karma-coverage?tab=readme-ov-file#advanced-multiple-reporters)    | No                  | `reports/ng-coverage.cobertura.xml` | [GitLab code coverage integration](https://docs.gitlab.com/ee/ci/testing/test_coverage_visualization.html) _(Cobertura format)_                                        |
| [karma-junit-reporter](https://github.com/karma-runner/karma-junit-reporter)                                                          | Yes                 | `reports/ng-test.xunit.xml`         | [GitLab unit tests integration](https://docs.gitlab.com/ci/testing/unit_test_reports/) _(JUnit format)_                                                         |
| [karma-coverage text-summary reporter](https://github.com/karma-runner/karma-coverage?tab=readme-ov-file#advanced-multiple-reporters) | No                  | N/A _(stdout)_                      | [GitLab MR test coverage results](https://docs.gitlab.com/ci/testing/code_coverage/#view-coverage-results) _(GitLab grabs coverage from stdout)_ |
| [karma-coverage cobertura reporter](https://github.com/karma-runner/karma-coverage?tab=readme-ov-file#advanced-multiple-reporters)    | No                  | `reports/ng-coverage.cobertura.xml` | [GitLab code coverage integration](https://docs.gitlab.com/ci/testing/code_coverage/) _(Cobertura format)_                                        |
| [karma-sonarqube-execution-reporter](https://github.com/lisrec/karma-sonarqube-execution-reporter)                                    | Yes                 | `reports/ng-test.sonar.xml`         | [SonarQube unit tests integration](https://docs.sonarsource.com/sonarqube-server/latest/analyzing-source-code/test-coverage/generic-test-data/#generic-test-coverage) _(generic SonarQube format)_                                              |
| [karma-coverage lcovonly reporter](https://github.com/karma-runner/karma-coverage?tab=readme-ov-file#advanced-multiple-reporters)     | No                  | `reports/ng-coverage.lcov.info`     | [SonarQube code coverage integration](https://docs.sonarsource.com/sonarqube-server/latest/analyzing-source-code/test-coverage/javascript-typescript-test-coverage/) _(JS/TS LCOV format)_             |

##### Code Coverage reports

In order to be able to compute and enable [GitLab code coverage integration](https://docs.gitlab.com/ee/ci/testing/test_coverage_visualization.html),
In order to be able to compute and enable [GitLab code coverage integration](https://docs.gitlab.com/ci/testing/code_coverage/),
the Angular template expects the following in your `karma.conf.js`:

1. Add the [karma-coverage](https://www.npmjs.com/package/karma-coverage) package:
@@ -168,7 +168,7 @@ the Angular template expects the following in your `karma.conf.js`:

##### Unit Tests reports

In order to be able to [integrate your test reports to GitLab](https://docs.gitlab.com/ee/ci/testing/unit_test_reports.html):
In order to be able to [integrate your test reports to GitLab](https://docs.gitlab.com/ci/testing/unit_test_reports/):

1. Add the [karma-junit-reporter](https://github.com/karma-runner/karma-junit-reporter) package as dev dependency:

@@ -238,9 +238,9 @@ Here is the required configuration if you're using [Jest](https://jestjs.io/) as

| Reporter                                                                                     | Needs `npm install` | Expected report file                | Usage                                                                                                                                                                  |
| -------------------------------------------------------------------------------------------- | ------------------- | ----------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [jest-junit](https://github.com/jest-community/jest-junit)                                   | Yes                 | `reports/ng-test.xunit.xml`         | [GitLab unit tests integration](https://docs.gitlab.com/ee/ci/testing/unit_test_reports.html) _(JUnit format)_                                                         |
| istanbul [text](https://istanbul.js.org/docs/advanced/alternative-reporters/#text)           | No                  | N/A _(stdout)_                      | [GitLab MR test coverage results](https://docs.gitlab.com/ee/ci/testing/code_coverage/#view-coverage-results) _(GitLab grabs coverage from stdout)_ |
| istanbul [cobertura](https://istanbul.js.org/docs/advanced/alternative-reporters/#cobertura) | No                  | `reports/ng-coverage.cobertura.xml` | [GitLab code coverage integration](https://docs.gitlab.com/ee/ci/testing/test_coverage_visualization.html) _(Cobertura format)_                                        |
| [jest-junit](https://github.com/jest-community/jest-junit)                                   | Yes                 | `reports/ng-test.xunit.xml`         | [GitLab unit tests integration](https://docs.gitlab.com/ci/testing/unit_test_reports/) _(JUnit format)_                                                         |
| istanbul [text](https://istanbul.js.org/docs/advanced/alternative-reporters/#text)           | No                  | N/A _(stdout)_                      | [GitLab MR test coverage results](https://docs.gitlab.com/ci/testing/code_coverage/#view-coverage-results) _(GitLab grabs coverage from stdout)_ |
| istanbul [cobertura](https://istanbul.js.org/docs/advanced/alternative-reporters/#cobertura) | No                  | `reports/ng-coverage.cobertura.xml` | [GitLab code coverage integration](https://docs.gitlab.com/ci/testing/code_coverage/) _(Cobertura format)_                                        |
| [jest-sonar](https://github.com/sh33dafi/jest-sonar)                                         | Yes                 | `reports/ng-test.sonar.xml`         | [SonarQube unit tests integration](https://docs.sonarsource.com/sonarqube-server/latest/analyzing-source-code/test-coverage/generic-test-data/#generic-test-coverage) _(generic SonarQube format)_                                              |
| istanbul [lcovonly](https://istanbul.js.org/docs/advanced/alternative-reporters/#lcovonly)   | No                  | `reports/ng-coverage.lcov.info`     | [SonarQube code coverage integration](https://docs.sonarsource.com/sonarqube-server/latest/analyzing-source-code/test-coverage/javascript-typescript-test-coverage/) _(JS/TS LCOV format)_             |

@@ -387,7 +387,7 @@ It uses the following variables:
- The `package-name` can be whatever you want.

For example, if your project is `https://gitlab.example.com/my-org/engineering-group/team-amazing/analytics`, the root namespace is `my-org`. When you publish a package, it must have `my-org` as the scope.
For more details see [Package naming convention](https://docs.gitlab.com/ee/user/packages/npm_registry/#package-naming-convention).
For more details see [Package naming convention](https://docs.gitlab.com/user/packages/npm_registry/#package-naming-convention).

:warning: Don't forget to specify the publication registry in the **project(s)** to publish `package.json` file (not the workspace top-level one).