Skip to content

Commit

Permalink
Update website to point to latest stable release
Browse files Browse the repository at this point in the history
  • Loading branch information
olafurpg committed Oct 18, 2021
1 parent e331ee3 commit 0a238df
Show file tree
Hide file tree
Showing 5 changed files with 12 additions and 6 deletions.
3 changes: 2 additions & 1 deletion build.sbt
Original file line number Diff line number Diff line change
Expand Up @@ -330,7 +330,8 @@ lazy val docs = project
(ThisBuild / baseDirectory).value / "website" / "target" / "docs",
mdocExtraArguments := List("--no-link-hygiene"),
mdocVariables := Map(
"VERSION" -> version.value.replaceFirst("\\+.*", "")
"VERSION" -> version.value.replaceFirst("\\+.*", ""),
"STABLE_VERSION" -> "0.7.29"
),
fork := false
)
Expand Down
4 changes: 4 additions & 0 deletions docs/fixtures.md
Original file line number Diff line number Diff line change
Expand Up @@ -181,6 +181,8 @@ class MySuite extends munit.FunSuite {

## Asynchronous fixtures with `FutureFixture`

> This feature is only available in the latest unstable version @VERSION@
Extend `FutureFixture[T]` to return `Future[T]` values from the lifecycle
methods `beforeAll`, `beforeEach`, `afterEach` and `afterAll`.

Expand Down Expand Up @@ -218,6 +220,8 @@ class AsyncFilesSuite extends FunSuite {

## Asynchronous fixtures with custom effect type

> This feature is only available in the latest unstable version @VERSION@
First, create a new `EffectFixture[T]` class that extends `munit.AnyFixture[T]`
and overrides all lifecycle methods to return values of type `Effect[Unit]`. For
example:
Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ MUnit is a Scala testing library with the following goals:
**sbt:**

```scala
libraryDependencies += "org.scalameta" %% "munit" % "@VERSION@" % Test
libraryDependencies += "org.scalameta" %% "munit" % "@STABLE_VERSION@" % Test
// Use %%% for non-JVM projects.
```

Expand Down
2 changes: 1 addition & 1 deletion docs/integrations/scalacheck.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ ScalaCheck support is provided as a separate module. You can add it to your
build via:

```scala
libraryDependencies += "org.scalameta" %% "munit-scalacheck" % "@VERSION@" % Test
libraryDependencies += "org.scalameta" %% "munit-scalacheck" % "@STABLE_VERSION@" % Test
```

You can then extend `ScalaCheckSuite` and write ScalaCheck property tests:
Expand Down
7 changes: 4 additions & 3 deletions docs/tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,9 +115,10 @@ class CustomTimeoutSuite extends munit.FunSuite {
}
```

Note that old version for MUnit (v0.x series) the timeout only applied to async
tests. Since the release of MUnit v1.0, the timeout applies to all tests
including non-async tests.
> Note that `munitTimeout` is only respected for async tests in the stable
> version version of MUnit (v0.x series). The setting is ignored by normal
> non-async tests. However, starting with MUnit v1.0 (latest milestone release:
> @VERSION@), the timeout applies to all tests including non-async tests.
## Run tests in parallel

Expand Down

0 comments on commit 0a238df

Please sign in to comment.