Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Deduplicate the discover step documentation #3311

Merged
merged 18 commits into from
Mar 11, 2025
Merged

Deduplicate the discover step documentation #3311

merged 18 commits into from
Mar 11, 2025
+117 −178

Conversation

mcasquer
Copy link
Collaborator

@mcasquer mcasquer commented Oct 23, 2024 •
edited
Loading

Currently, the documentation about discover is duplicated in someway between the specification and the plugin section. Adds the missing information into the plugin section as it will be the primary source.

Pull Request Checklist

  • write the documentation
  • update the specification
  • adjust plugin docstring

@mcasquer
Copy link
Collaborator Author

@psss I am not sure about deleting also the follwoing lines

tmt/tmt/steps/discover/fmf.py

Lines 229 to 237 in 1de4920

It is also possible to limit tests only to those that have changed
in git since a given revision. This can be particularly useful when
testing changes to tests themselves (e.g. in a pull request CI).
Related config options (all optional):
* ``modified-only`` - set to ``true`` if you want to filter modified tests
* ``modified-url`` - fetched as "reference" remote in the test dir
* ``modified-ref`` - the ref to compare against

The configs are explained in the inherited configuration

@mcasquer mcasquer force-pushed the discover_deduplication branch from 1de4920 to f467ba5 Compare October 23, 2024 10:41
@mcasquer
Copy link
Collaborator Author

Also @psss should I include the removal of the no longer needed information from the specs in this PR?

@mcasquer mcasquer marked this pull request as ready for review November 11, 2024 08:51
@mcasquer mcasquer force-pushed the discover_deduplication branch from f467ba5 to 137f23f Compare January 20, 2025 13:23
@mcasquer mcasquer requested a review from martinhoyer as a code owner January 20, 2025 13:23
@mcasquer mcasquer force-pushed the discover_deduplication branch 6 times, most recently from 6fcb18e to 443cc56 Compare January 27, 2025 14:03
@happz happz added this to the 1.43 milestone Jan 30, 2025
@happz happz added the documentation Improvements or additions to documentation label Jan 30, 2025
therazix
therazix reviewed Feb 4, 2025
View reviewed changes
Copy link
Collaborator

@therazix therazix left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, just a couple formatting suggestions.

@mcasquer mcasquer force-pushed the discover_deduplication branch from 1dd0e5a to c71fac2 Compare February 4, 2025 22:38
@mcasquer
Copy link
Collaborator Author

mcasquer commented Feb 5, 2025

Hello, how can I fix the CI pathspec issue?
error: pathspec '1.42.0' did not match any file(s) known to git

@happz
Copy link
Collaborator

happz commented Feb 5, 2025

Hello, how can I fix the CI pathspec issue? error: pathspec '1.42.0' did not match any file(s) known to git

Hopefully soon to be fixed by #3507

happz
happz reviewed Feb 5, 2025
View reviewed changes
happz
happz reviewed Feb 5, 2025
View reviewed changes
happz
happz reviewed Feb 5, 2025
View reviewed changes
happz
happz reviewed Feb 5, 2025
View reviewed changes
happz
happz reviewed Feb 5, 2025
View reviewed changes
psss
psss requested changes Mar 11, 2025
View reviewed changes
Copy link
Collaborator

@psss psss left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, all in all looks very good. Just a couple of small suggestions.

@mcasquer mcasquer mentioned this pull request Mar 11, 2025
Open
8 tasks
mcasquer and others added 17 commits March 11, 2025 14:40
@mcasquer @psss
Deduplicates discover information
95c2859 
Currently, the documentation about discover is duplicated
in someway between the specification and the plugin section.
Adds the missing information into the plugin section as it
will be the primary source.

Signed-off-by: mcasquer <mcasquer@redhat.com>
@mcasquer @psss
Adds more information to fmf plugin options.
13da3f5 
Updates the modified tests behavior configs putting
more information and adds all the parameters supported.

Signed-off-by: mcasquer <mcasquer@redhat.com>
@mcasquer @psss
Removes excluded files
49db8ef 
Signed-off-by: mcasquer <mcasquer@redhat.com>
@mcasquer @psss
Moves the info of the config directly to the command help
b565e3d 
Signed-off-by: mcasquer <mcasquer@redhat.com>
@mcasquer @psss
Removes duplicated information from modified-* configs
0f0abd1 
Signed-off-by: mcasquer <mcasquer@redhat.com>
@mcasquer @psss
Adds shell configs information directly on the help
e0a1900 
Signed-off-by: mcasquer <mcasquer@redhat.com>
@mcasquer @psss
Removes single quotes not being well rendered in the display
e54eb8d 
Signed-off-by: mcasquer <mcasquer@redhat.com>
@mcasquer @psss
Small format fixes
86cb74d 
Signed-off-by: mcasquer <mcasquer@redhat.com>
@mcasquer @psss
Marks some terms as literals
1417df2 
Signed-off-by: mcasquer <mcasquer@redhat.com>
@mcasquer @psss
Expands information of the ref config
4841669 
Signed-off-by: mcasquer <mcasquer@redhat.com>
@mcasquer @psss
Removes duplicated information from discover spec
c3568b9 
Also adds some missing information for dis git configs.

Signed-off-by: mcasquer <mcasquer@redhat.com>
@mcasquer @psss
Introduces a new function to render the emphasis
c5f5b7c 
Also updates the adjust litearal to be compatible with this function.

Signed-off-by: mcasquer <mcasquer@redhat.com>
@mcasquer @psss
Updates filter and link configs and some words to be literals
90a0328 
Signed-off-by: mcasquer <mcasquer@redhat.com>
@mcasquer @psss
Adds a reference to fmf plugin doc
9d8f8b9 
Signed-off-by: mcasquer <mcasquer@redhat.com>
@mcasquer @psss
Keeps modified-* keys list
09995f7 
Signed-off-by: mcasquer <mcasquer@redhat.com>
@mcasquer @psss
Mark rpm-build as literal and adds a list of test discovery keys
10c40ec 
Signed-off-by: mcasquer <mcasquer@redhat.com>
@psss
A couple of minor nitpicks
fbdef5b
@psss psss force-pushed the discover_deduplication branch from 971781d to fbdef5b Compare March 11, 2025 13:40
@happz 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 Mar 11, 2025
@psss
Copy link
Collaborator

psss commented Mar 11, 2025

Documentation changes only, merging.

@psss psss merged commit 092cbff into teemtee:main Mar 11, 2025
11 of 22 checks passed
@psss psss self-assigned this Mar 11, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@psss psss psss approved these changes

@therazix therazix therazix approved these changes

@lukaszachy lukaszachy Awaiting requested review from lukaszachy lukaszachy is a code owner

@thrix thrix Awaiting requested review from thrix thrix is a code owner

@janhavlin janhavlin Awaiting requested review from janhavlin janhavlin is a code owner

@martinhoyer martinhoyer Awaiting requested review from martinhoyer martinhoyer is a code owner

@KwisatzHaderach KwisatzHaderach Awaiting requested review from KwisatzHaderach

@happz happz Awaiting requested review from happz happz is a code owner

Assignees

@psss psss

Labels
documentation Improvements or additions to documentation status | ready for merge The only missing piece is to do the rebase the current 'main' and let the CI finish.
Projects
None yet
Milestone
1.44
Development

Successfully merging this pull request may close these issues.
6 participants
@mcasquer @happz @psss @KwisatzHaderach @therazix @lukaszachy