TYPO3-Documentation / TYPO3CMS-Reference-CoreApi

"TYPO3 Explained": Main TYPO3 Core Document: Main classes, Security, TypoScript syntax, Extension API and much more
https://docs.typo3.org/m/typo3/reference-coreapi/master/en-us/
21 stars 370 forks source link

[TASK] Add information about Test Runners, with their advantages and disadvantages #4554

Closed garvinhicking closed 1 week ago

garvinhicking commented 2 weeks ago

This is a larger (not-yet-proofread) chapter on the topic of Test Runners. I feel this has often been a topic in the community, and the current improvements on documenting testing rectify being more verbose on this.

I propose to merge this and iterate on it with followup-PRs, if the basis of this PR is agreeable.

I've requested a few reviews for this because I'd like to have everyone involved on-board with this, I hope that's ok.

linawolf commented 2 weeks ago

I only have some remarks regarding rst syntax and best practices

garvinhicking commented 1 week ago

I only have some remarks regarding rst syntax and best practices

What do you think about the content itself?

linawolf commented 1 week ago

What do you think about the content itself?

I think the content is a great starting point and can be improved successibly! Thanks for writing this down!

DanielSiepmann commented 1 week ago

I've read through the whole PR and like the idea and way you go. I guess the list of advantags an disavantages is never finished and everyone might have his or her own thoughts about that. So this is a great starting point and might help people to get to know the possibilities.

Thanks for your efforts.

github-actions[bot] commented 1 week ago

The backport to 11.5 failed:

The process '/usr/bin/git' failed with exit code 1
stderr ``` error: could not apply 8ad29236... [TASK] Add information about Test Runners hint: After resolving the conflicts, mark them with hint: "git add/rm ", then run hint: "git cherry-pick --continue". hint: You can instead skip this commit with "git cherry-pick --skip". hint: To abort and get back to the state before "git cherry-pick", hint: run "git cherry-pick --abort". hint: Disable this message with "git config advice.mergeConflict false" ```
stdout ``` Auto-merging Documentation/Testing/ExtensionTesting.rst CONFLICT (content): Merge conflict in Documentation/Testing/ExtensionTesting.rst CONFLICT (modify/delete): Documentation/Testing/FunctionalTesting/Introduction.rst deleted in HEAD and modified in 8ad29236 ([TASK] Add information about Test Runners). Version 8ad29236 ([TASK] Add information about Test Runners) of Documentation/Testing/FunctionalTesting/Introduction.rst left in tree. Auto-merging Documentation/Testing/Index.rst CONFLICT (content): Merge conflict in Documentation/Testing/Index.rst Auto-merging Documentation/Testing/ProjectTesting.rst CONFLICT (content): Merge conflict in Documentation/Testing/ProjectTesting.rst CONFLICT (modify/delete): Documentation/Testing/UnitTesting/Running.rst deleted in HEAD and modified in 8ad29236 ([TASK] Add information about Test Runners). Version 8ad29236 ([TASK] Add information about Test Runners) of Documentation/Testing/UnitTesting/Running.rst left in tree. Auto-merging Documentation/Testing/WritingAcceptance.rst ```

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-11.5 11.5
# Navigate to the new working tree
cd .worktrees/backport-11.5
# Create a new branch
git switch --create backport-4554-to-11.5
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick 8ad2923650c9f445791a77c808901ff967ddeb8d,3b54469285ea37b77eddaca29f02d5360e2964db,b8330797ce3657577e475965881bd2960d7b196f,56859dfb5463644023d8b5f1f8dc5923f80a805a,48640675310b0962401cb4edba88fb7a1846ff49,14c775698e991c496d65e80244468539d707d20f,66cac0f6636e5bee727eea7432cffe7115df6db2,c2136d80925d4844b1c20eb891cbc8a71f7ebcbf,c25b41be61d7a9b32280017af440e0730b7fb9fc,f06da6a0315571a79cf676c47513a79602632b0f,b040d61db17ce82405c11b96f75c43795817d227,bc0db15fc5677ce7409496935dd07bd64c312f7e
# Push it to GitHub
git push --set-upstream origin backport-4554-to-11.5
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-11.5

Then, create a pull request where the base branch is 11.5 and the compare/head branch is backport-4554-to-11.5.

linawolf commented 1 week ago

Please address additional issues in follow up PRs or issues

garvinhicking commented 1 week ago

Please address additional issues in follow up PRs or issues

Will do, wanted to link the sections like you wished for. Will try make time for it.