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.

Sign up for GitHub

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

Update website to point to latest stable release #443

Merged
merged 1 commit into from
Oct 18, 2021
Merged

Update website to point to latest stable release #443

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion build.sbt
View file
Open in desktop
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"
Comment on lines -333 to +334
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would've probably left VERSION as-is, and introduced a NEXT_MAJOR_VERSION or something, so that you wouldn't have to change existing uses of VERSION, but it's a minor thing, feel free to ignore

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I agree. Thought about the same after going through the docs refactoring. Gonna keep the changes though since they're already done, it wasn't a huge diff

),
fork := false
)
Expand Down
4 changes: 4 additions & 0 deletions docs/fixtures.md
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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