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.

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

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

Merged
merged 12 commits into from
Jul 1, 2024

Conversation

fflaten
Copy link
Collaborator

@fflaten fflaten commented Jun 30, 2024

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 Add v6 preview docs docs#316
    • Includes Type for each configuration option.

Fix #2491
Related pester/docs#280 (comment)

PR Checklist

  • PR has meaningful title
  • Summary describes changes
  • 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)
  • Documentation is updated/added (if required)

@nohwnd nohwnd merged commit 6754b26 into pester:main Jul 1, 2024
11 checks passed
@fflaten
Copy link
Collaborator Author

fflaten commented Jul 1, 2024

Nice. Should I create a matching PR for v5?

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

@nohwnd
Copy link
Member

nohwnd commented Jul 1, 2024 via email

@fflaten
Copy link
Collaborator Author

fflaten commented Jul 1, 2024

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

@fflaten
Copy link
Collaborator Author

fflaten commented Jul 1, 2024

/backport to rel/5.6.x

Copy link

github-actions bot commented Jul 1, 2024

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

Copy link

github-actions bot commented Jul 1, 2024

@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!

Copy link

github-actions bot commented Jul 1, 2024

@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
Copy link
Collaborator Author

fflaten commented Jul 1, 2024

Guess it's manual cherry pick then 😁

fflaten added a commit to fflaten/Pester that referenced this pull request Jul 1, 2024
…bout_PesterConfiguration (pester#2518)

* Remove outdated docs

* Include option types in PesterConfiguration docs

* Add draft for about_PesterConfiguration help topic

* Move PesterConfiguration options reference to help topic

* Minor text updates

* wip

* Update Invoke-Pester help for Configuration

* Update build script

* Update help for Invoke-Pester -Configuration

* Fix build script

* Update about_Pester.help.txt

* Update release script
@fflaten fflaten deleted the about-help branch July 1, 2024 17:41
nohwnd pushed a commit that referenced this pull request Jul 2, 2024
…bout_PesterConfiguration (#2518) (#2522)

* Remove outdated docs

* Include option types in PesterConfiguration docs

* Add draft for about_PesterConfiguration help topic

* Move PesterConfiguration options reference to help topic

* Minor text updates

* wip

* Update Invoke-Pester help for Configuration

* Update build script

* Update help for Invoke-Pester -Configuration

* Fix build script

* Update about_Pester.help.txt

* Update release script
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Remove or update included about_ help files
2 participants