The source project of this merge request has been removed.
Fix maven & gradle examples in the docs, enabling line-by-line display of test coverage in merge requests out-of-the-box (for java & kotlin)
requested to merge (removed):philzen-fix-line-by-line-test-coverage-setup-for-maven-example into master
What does this MR do?
Just as the commit messages state:
-
Fix java and kotlin examples to work out-of-the-box
This enables line-by-line display of test coverage in merge requests.
As discovered in this discussion, a trailing slash together with a proper base prefix is required to make this work. Execution ofsource2filename.py
script is no longer required since "Automatic classpath correction" was introduced for the gitlab cobertura parser. -
Remove single quotes from scripts in maven example
Technically they aren't needed for single-line commands, while omitting them makes for a nicer code coloring in some IDEs (such as IntelliJ) -
Amend imperative to present tense in comment
Reading the imperative "use" may imply that there is a TODO for users of this example, why there is none anymore, as this can now be used w/o further customizations and line-by-line coverage display in merge request should start working straightaway. Still keeping it there in descriptive, present-tense form of "using", so in case users want to experiment with it is still transparent that this path needs to be relative to the project root.
Related issues
Those issues are related, but not solved by this MR:
Author's checklist (required)
-
Follow the Documentation Guidelines and Style Guide. - If you have Developer permissions or higher:
-
Ensure that the product tier badge is added to doc's h1
. -
Apply the documentation label, plus: - The corresponding DevOps stage and group labels, if applicable.
-
development guidelines when changing docs under
doc/development/*
,CONTRIBUTING.md
, orREADME.md
. -
development guidelines and Documentation guidelines when changing docs under
development/documentation/*
. - development guidelines and Description templates (.gitlab/*) when creating/updating issue and MR description templates.
-
Request a review from the designated Technical Writer.
-
Review checklist
All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.
1. Primary Reviewer
-
Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.
2. Technical Writer
-
Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage. -
Ensure docs metadata are present and up-to-date. -
Ensure Technical Writing and documentation are added. -
Add the corresponding docs::
scoped label. -
If working on UI text, add the corresponding UI Text
scoped label. -
Add twdoing when starting work on the MR. -
Add twfinished if Technical Writing team work on the MR is complete but it remains open.
-
For more information about labels, see Technical Writing workflows - Labels.
For suggestions that you are confident don't need to be reviewed, change them locally and push a commit directly to save others from unneeded reviews. For example:
- Clear typos, like
this is a typpo
. - Minor issues, like single quotes instead of double quotes, Oxford commas, and periods.
For more information, see our documentation on Merging a merge request.
3. Maintainer
-
Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review. -
Ensure a release milestone is set. -
If there has not been a technical writer review, create an issue for one using the Doc Review template.
Edited by Phil