Extend Tags docs to include the tags SettingsKey
Nobody has claimed this yet.
- Dominant language
- Scala
- Stars
- 73
- Forks
- 351
- Avg merge
- 5h 21m
- Merged PRs (30d)
- 9
Description
In our project we have a bunch of tests that can run in parallel and a whole bunch that cannot. To split these out we've created a custom scope and ran them with parallelExecution := false.
This worked great as long as we had a simple project, but the moment we went to a multi-module troubles kicked in because we couldn't assure that test tasks from the different projects were not running in parallel.
After a lot of digging through the sbt source in combination with the ParallelExecution page I found out that I could create a custom tag and tie it to my custom scope with the tag SettingsKey.
Let's say it wasn't a pleasant experience and it would be very useful if this awesome feature could be documented on the website. I'm sure many ppl are running into this in large projects that contain integration tests.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the linked Parallel-Execution page and the sbt source references in the issue, focusing on the custom tag and tag SettingsKey. Document how tags can coordinate parallel execution across multi-module projects, including the integration-test use case; the page should explain this workflow clearly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- scala
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 50/100