ArchipelagoMW / Archipelago

Archipelago Multi-Game Randomizer and Server
https://archipelago.gg
Other
466 stars 621 forks source link

Core: Update docs related to running test #2721

Open ReverM opened 8 months ago

ReverM commented 8 months ago

What task needs to be completed?

https://github.com/ArchipelagoMW/Archipelago/blob/main/docs/running%20from%20source.md#running-tests and https://github.com/ArchipelagoMW/Archipelago/blob/main/docs/tests.md both have sections about running test.

black-sliver commented 8 months ago

What new button?

I think we should retain the pytest, maybe just as "running tests without PyCharm". Also adding pytest-xdist in there wouldn't hurt: https://github.com/ArchipelagoMW/Archipelago/blob/main/.github/workflows/unittests.yml#L56 is what we do in CI to reduce runtime of tests. On my PC it speeds up tests ~7x and heats the room a lot faster.

ReverM commented 8 months ago

What new button?

image

black-sliver commented 8 months ago

Oh, unless I am mistaken that button isn't actually "new". It's just now hopefully always pre-configured to work.

ReverM commented 8 months ago

The doc should still mention it I think

black-sliver commented 8 months ago

Yeah, showing how to run tests is a good idea. I was just confused by the wording