Deduplicate the `report` step documentation #3644

mcasquer · 2025-04-03T10:38:20Z

Deduplicates the report step documentation, which includes the following:

Moving all the information from the specs to the plugins section
Updates the header in the plugins section
Remove completely (whenever is possible) the references in the specs
Fixes some references to the removed documentation
Directly refer the reader to the report plugins and add implemented-by link.

Pull Request Checklist

update the specification
adjust plugin docstring

tmt/steps/report/reportportal.py

psss

Let's add an introduction header to the report plugin section and completely remove the plugin-specific content from the specification as we've done with the finish steps docs.

mcasquer · 2025-04-15T12:47:48Z

Hitting some warnings when compiling due to mentions of polarion and html specs in the release notes. @psss let me know if this is harmless so I can push the changes :)

docs/releases.rst:738: WARNING: undefined label: '/spec/plans/report/polarion'
docs/releases.rst:787: WARNING: undefined label: '/spec/plans/report/html'
docs/releases.rst:804: WARNING: undefined label: '/spec/plans/report/html'

tmt/docs/releases.rst

Line 738 in 718c4e4

The :ref:`/spec/plans/report/polarion` report now supports the

tmt/docs/releases.rst

Line 787 in 718c4e4

The :ref:`/spec/plans/report/html` report plugin now shows

tmt/docs/releases.rst

Line 804 in 718c4e4

The :ref:`/spec/plans/report/html` report plugin now shows

happz · 2025-04-15T13:09:45Z

Hitting some warnings when compiling due to mentions of polarion and html specs in the release notes. @psss let me know if this is harmless so I can push the changes :)
docs/releases.rst:738: WARNING: undefined label: '/spec/plans/report/polarion'
docs/releases.rst:787: WARNING: undefined label: '/spec/plans/report/html'
docs/releases.rst:804: WARNING: undefined label: '/spec/plans/report/html'
tmt/docs/releases.rst

Line 738 in 718c4e4

The :ref:`/spec/plans/report/polarion` report now supports the

tmt/docs/releases.rst

Line 787 in 718c4e4

The :ref:`/spec/plans/report/html` report plugin now shows

tmt/docs/releases.rst

Line 804 in 718c4e4

The :ref:`/spec/plans/report/html` report plugin now shows

Needs to be fixed in this PR: you removed a piece of docs something referred to, so the reference must be either fixed, or removed.

psss

Thanks for addressing all comments. One small typo fixed in 2bd962c. Ready for merge.

psss · 2025-04-16T14:54:41Z

Plus one small leftover: db9d018

Signed-off-by: mcasquer <[email protected]>

Consequently, updates the references to the removed docs and updates the report plugin header. Signed-off-by: mcasquer <[email protected]>

Signed-off-by: mcasquer <[email protected]>

Introduced in #3644

happz · 2025-04-16T20:44:46Z

@psss we should wait for at least some of the core test jobs to complete. This PR introduces an issue into spec/plans/report.fmf:

A node in tree loaded from ../.. failed validation

* /spec/plans/report/file:link - None is not valid under any of the given schemas

Detailed validation error:

  None is not valid under any of the given schemas

  Failed validating 'oneOf' in schema['properties']['link']:
      {'oneOf': [ordereddict([('$ref', '/schemas/common#/definitions/link')]), ordereddict([('type', 'array'), ('items', ordereddict([('$ref', '/schemas/common#/definitions/link')]))])]}

  On instance['link']:
      None

Reported by tests/unit/test_schema.py, fixing in #3677

Introduced in #3644

psss · 2025-04-17T08:37:23Z

@psss we should wait for at least some of the core test jobs to complete.

Ah, I see, understood. Thanks for the headsup!

Signed-off-by: mcasquer <[email protected]> Co-authored-by: Petr Šplíchal <[email protected]>

Introduced in #3644

mcasquer force-pushed the report_deduplication branch from 512e9d0 to 7c117e5 Compare April 3, 2025 11:01

mcasquer changed the title ~~Deduplicates the report documentation~~ Deduplicates the report step documentation Apr 3, 2025

mcasquer force-pushed the report_deduplication branch from 7c117e5 to e65994b Compare April 3, 2025 11:41

happz added this to planning Apr 3, 2025

github-project-automation bot moved this to backlog in planning Apr 3, 2025

happz moved this from backlog to review in planning Apr 3, 2025

happz removed this from planning Apr 3, 2025

mcasquer force-pushed the report_deduplication branch from 84eda59 to ba03d64 Compare April 4, 2025 09:14

mcasquer commented Apr 4, 2025

View reviewed changes

tmt/steps/report/reportportal.py Show resolved Hide resolved

mcasquer marked this pull request as ready for review April 4, 2025 09:30

mcasquer requested review from KwisatzHaderach, psss, lukaszachy, thrix, janhavlin and martinhoyer as code owners April 4, 2025 09:30

mcasquer force-pushed the report_deduplication branch from ba03d64 to f6bbde5 Compare April 8, 2025 06:45

psss changed the title ~~Deduplicates the report step documentation~~ Deduplicate the report step documentation Apr 9, 2025

psss added this to planning Apr 9, 2025

github-project-automation bot moved this to backlog in planning Apr 9, 2025

psss added documentation Improvements or additions to documentation step | report Stuff related to the report step labels Apr 9, 2025

psss added this to the 1.47 milestone Apr 10, 2025

psss moved this from backlog to implement in planning Apr 15, 2025

psss requested changes Apr 15, 2025

View reviewed changes

psss mentioned this pull request Apr 15, 2025

Deduplicate plugin documentation #1256

Closed

mcasquer force-pushed the report_deduplication branch from f6bbde5 to 8cbbcfa Compare April 16, 2025 08:08

mcasquer requested a review from 4N0body5 as a code owner April 16, 2025 08:08

psss moved this from implement to review in planning Apr 16, 2025

therazix approved these changes Apr 16, 2025

View reviewed changes

psss force-pushed the report_deduplication branch from 9dce539 to 2bd962c Compare April 16, 2025 13:54

psss approved these changes Apr 16, 2025

View reviewed changes

psss requested a review from happz April 16, 2025 13:55

psss moved this from review to merge in planning Apr 16, 2025

happz added the status | ready for merge The only missing piece is to do the rebase the current 'main' and let the CI finish. label Apr 16, 2025

mcasquer and others added 11 commits April 16, 2025 17:19

deduplicates display component documentation

1285020

Signed-off-by: mcasquer <[email protected]>

Moves html component information to plugins documentation

368cafa

Signed-off-by: mcasquer <[email protected]>

Deduplicates the junit component

8939ded

Signed-off-by: mcasquer <[email protected]>

Deduplication of Beaker component in report spec

4afe2a1

Signed-off-by: mcasquer <[email protected]>

Deduplicates reportportal component

279ed8f

Signed-off-by: mcasquer <[email protected]>

Deduplicates reportportal component

f684aef

Signed-off-by: mcasquer <[email protected]>

Adds missing comma

cd5c4bf

Signed-off-by: mcasquer <[email protected]>

Removes the plugin-related information from specs

6858291

Consequently, updates the references to the removed docs and updates the report plugin header. Signed-off-by: mcasquer <[email protected]>

Implements Petr's suggestions

0b15ba6

Signed-off-by: mcasquer <[email protected]>

Fix the code-block type

c6bc76d

The /spec/plans/report/file story is a draft

f17d964

psss force-pushed the report_deduplication branch from db9d018 to f17d964 Compare April 16, 2025 15:20

psss merged commit 4ea4ae5 into main Apr 16, 2025
5 of 21 checks passed

psss deleted the report_deduplication branch April 16, 2025 15:22

github-project-automation bot moved this from merge to done in planning Apr 16, 2025

happz added a commit that referenced this pull request Apr 16, 2025

Fix invalid link of /spec/plans/report/file

1d543b9

Introduced in #3644

happz mentioned this pull request Apr 16, 2025

Fix invalid link of /spec/plans/report/file #3677

Merged

1 task

happz added a commit that referenced this pull request Apr 16, 2025

Fix invalid link of /spec/plans/report/file (#3677)

a3bf84d

Introduced in #3644

bajertom pushed a commit that referenced this pull request Aug 11, 2025

Deduplicate the report step documentation (#3644)

09bdaa6

Signed-off-by: mcasquer <[email protected]> Co-authored-by: Petr Šplíchal <[email protected]>

bajertom pushed a commit that referenced this pull request Aug 11, 2025

Fix invalid link of /spec/plans/report/file (#3677)

116b72b

Introduced in #3644

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Deduplicate the `report` step documentation #3644

Deduplicate the `report` step documentation #3644

Uh oh!

mcasquer commented Apr 3, 2025 •

edited

Loading

Uh oh!

Uh oh!

psss left a comment

Uh oh!

mcasquer commented Apr 15, 2025

Uh oh!

happz commented Apr 15, 2025

Uh oh!

psss left a comment

Uh oh!

psss commented Apr 16, 2025

Uh oh!

Uh oh!

happz commented Apr 16, 2025

Uh oh!

psss commented Apr 17, 2025

Uh oh!

Uh oh!

Deduplicate the report step documentation #3644

Deduplicate the report step documentation #3644

Uh oh!

Conversation

mcasquer commented Apr 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

psss left a comment

Choose a reason for hiding this comment

Uh oh!

mcasquer commented Apr 15, 2025

Uh oh!

happz commented Apr 15, 2025

Uh oh!

psss left a comment

Choose a reason for hiding this comment

Uh oh!

psss commented Apr 16, 2025

Uh oh!

Uh oh!

happz commented Apr 16, 2025

Uh oh!

psss commented Apr 17, 2025

Uh oh!

Uh oh!

Deduplicate the `report` step documentation #3644

Deduplicate the `report` step documentation #3644

mcasquer commented Apr 3, 2025 •

edited

Loading