Cleanup about_* help topics and extract PesterConfiguration docs to about_PesterConfiguration

fflaten commented 2 weeks ago

PR Summary

Removes outdated about_* help topics that are no longer maintained.
Updates about_Pester as a quick introduction pointing the user to the website for full docs.
Moves PesterConfiguration reference docs to about_PesterConfiguration to simplify New-PesterConfiguration help and match similar extracted docs on website to Usage\Configuration. See pester/docs#316
- Includes Type for each configuration option.

PR Checklist

[x] PR has meaningful title
[x] Summary describes changes
[x] PR is ready to be merged
- If not, use the arrow next to Create Pull Request to mark it as a draft. PR can be marked Ready for review when it's ready.
[ ] Tests are added/update (if required)
[x] Documentation is updated/added (if required)

fflaten commented 2 weeks ago

Nice. Should I create a matching PR for v5?

V6-docs PR includes the same PesterConfiguration in usage/Configurarion for v5.

nohwnd commented 2 weeks ago

Backport bot? :)

Odesláno z aplikace Outlook pro iOShttps://aka.ms/o0ukef

Od: Frode Flaten @.> Odesláno: Monday, July 1, 2024 6:51:04 PM Komu: pester/Pester @.> Kopie: Jakub Jareš @.>; State change @.> Předmět: Re: [pester/Pester] Cleanup about_* help topics and extract PesterConfiguration docs to about_PesterConfiguration (PR #2518)

Nice. Should I create a matching PR for v5?

V6-docs PR includes the same PesterConfiguration in usage/Configurarion for v5.

— Reply to this email directly, view it on GitHubhttps://github.com/pester/Pester/pull/2518#issuecomment-2200618710, or unsubscribehttps://github.com/notifications/unsubscribe-auth/ABLYLYNRYRSXJHNKIWTMXE3ZKGCHRAVCNFSM6AAAAABKEHEFZKVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDEMBQGYYTQNZRGA. You are receiving this because you modified the open/close state.Message ID: @.***>

fflaten commented 2 weeks ago

Yeah, I'll use it as a draft. Need some adjustments to build script + generated docs for v5. 🙂

fflaten commented 2 weeks ago

/backport to rel/5.6.x

github-actions[bot] commented 2 weeks ago

Started backporting to rel/5.6.x: https://github.com/pester/Pester/actions/runs/9748483082

github-actions[bot] commented 2 weeks ago

@fflaten backporting to rel/5.6.x failed, the patch most likely resulted in conflicts:

$ git am --3way --ignore-whitespace --keep-non-patch changes.patch

Applying: Remove outdated docs
Using index info to reconstruct a base tree...
M   src/en-US/about_Mocking.help.txt
Falling back to patching base and 3-way merge...
Removing src/en-US/about_TestDrive.help.txt
Removing src/en-US/about_Should.help.txt
CONFLICT (modify/delete): src/en-US/about_Mocking.help.txt deleted in Remove outdated docs and modified in HEAD. Version HEAD of src/en-US/about_Mocking.help.txt left in tree.
Removing src/en-US/about_BeforeEach_AfterEach.help.txt
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
hint: When you have resolved this problem, run "git am --continue".
hint: If you prefer to skip this patch, run "git am --skip" instead.
hint: To restore the original branch and stop patching, run "git am --abort".
hint: Disable this message with "git config advice.mergeConflict false"
Patch failed at 0001 Remove outdated docs
Error: The process '/usr/bin/git' failed with exit code 128

Please backport manually!

github-actions[bot] commented 2 weeks ago

@fflaten an error occurred while backporting to rel/5.6.x, please check the run log for details!

Error: git am failed, most likely due to a merge conflict.

fflaten commented 2 weeks ago

Guess it's manual cherry pick then 😁

pester / Pester

Cleanup about_* help topics and extract PesterConfiguration docs to about_PesterConfiguration #2518

PR Summary

PR Checklist