diff --git a/README.md b/README.md index c07e3e5e..bdbe92c7 100644 --- a/README.md +++ b/README.md @@ -209,44 +209,18 @@ object ForallExamples extends SimpleIOSuite with Checkers { Contributions are most welcome ! -### Development requirements - -:warning: This repository uses [Git LFS](https://git-lfs.github.com/). Having it installed is required for -`git checkout` to work properly. - -To install for Mac using `brew`: - -```bash -brew install git-lfs -git lfs install -``` - -If you want to build and run the website then you will need yarn installed: - -```bash -brew install yarn -``` - ### Building the website If you're changing documentation, here's how you can check your changes locally: ```bash -sbt docs/docusaurusCreateSite -cd website -yarn start +sbt docs/tlSitePreview ``` -If you're only changing `.md` files, you can run `sbt '~docs/mdoc'`. - -If you want to view images, such as the logo, use `git lfs` to check them out: - -```bash -git lfs install --local -git lfs pull -``` +Then navigate to `http://localhost:4242` to see the documentation site. -Note that the site will look a tiny bit different because to build a versioned website we have some machinery in the script running on CI - but you don't have to worry about that. +Weaver uses `sbt-typelevel-site`, for more details on writing documentation +[see here](https://typelevel.org/sbt-typelevel/site.html#quick-start). ### PR Guidelines @@ -257,6 +231,6 @@ Please: ## Inspiration -A **HUGE** thank you to Alexandru Nedelcu, author of [Monix](https://github.com/monix/monix) and contributor to -cats-effect, as he wrote the [minitest](https://github.com/monix/minitest) +A **HUGE** thank you to Alexandru Nedelcu, author of [Monix](https://github.com/monix/monix) +and contributor to cats-effect, as he wrote the [minitest](https://github.com/monix/minitest) framework which got this framework started. diff --git a/docs/faqs/other_effects.md b/docs/faqs/other_effects.md index 480fc782..962359b5 100644 --- a/docs/faqs/other_effects.md +++ b/docs/faqs/other_effects.md @@ -1,20 +1,20 @@ -What happened to ZIO / Monix / MonixBIO ? -============= +What happened to other effect types ? +===================================== -Starting with version 0.8.0, Weaver no longer offers out-of-the-box support for other effect types -than cats-effect. +Starting with version 0.8.0, Weaver only supports cats-effect out-of-the-box. -We (maintainers) are happy to keep the core of weaver effect-agnostic, in an effort to allow for third party -to resurrect support for the effect types they use in repository they control. +We (maintainers) are happy to keep the core of weaver effect-agnostic, in an +effort to allow for third party to resurrect support for the effect types they +use in repository they control. -You can read about the rationale for decision [here](https://github.com/disneystreaming/weaver-test/discussions/570). Feel free to ping us via a github discussion, if you seek to resurrect support for a given effect-type. +If you are looking for documentation of the legacy branches of weaver that did +support other effect types, you can find it [in the archived repository](https://github.com/disneystreaming/weaver-test/blob/v0.6.15/docs/installation.md). -If you are looking for documentation of the maintenance branch of weaver that did support other effect types, you can find it [over there](https://github.com/disneystreaming/weaver-test/blob/v0.6.15/docs/installation.md). +To summarize : -We will try to fix critical bugs on the 0.6/0.7 series, as they get found. - -To summarise : - -* `0.8.x` and further -> CE3 only, active development, -* `0.7.x` -> CE3 + ZIO 1 support (maintenance mode, fixing critical bugs that not have workarounds) -* `0.6.x` -> CE2 + Monix/MonixBIO/ZIO 1 support (maintenance mode, fixing critical bugs that do not have workarounds) +| Version | Cats Effect | ZIO | Monix | maintained? | +| ------- | ----------- | ------ | ------ | ----------- | +| 0.9.x | ✅ 3.x | ❌ | ❌ | ✅ | +| 0.8.x | ✅ 3.x | ❌ | ❌ | ❌ | +| 0.7.x | ✅ 3.x | ✅ 1.x | ❌ | ❌ | +| 0.6.x | ✅ 2.x | ✅ 1.x | ✅ 3.x | ❌ | diff --git a/scripts/releaseSite.sc b/scripts/releaseSite.sc deleted file mode 100644 index a206c2e0..00000000 --- a/scripts/releaseSite.sc +++ /dev/null @@ -1,169 +0,0 @@ -import $ivy.`com.lihaoyi::requests:0.6.5` -import $ivy.`com.lihaoyi::upickle:0.9.5` - -import scala.jdk.CollectionConverters._ -import java.nio.file.attribute.PosixFilePermission.OWNER_EXECUTE - -// format: off - -// Assumes mdoc has been run. -@main -def main(): Unit = { - - if(sys.env.get("GITHUB_DEPLOY_KEY").nonEmpty) doInstallSSH() - - if (!os.exists(os.pwd / "modules" / "docs" / "target" / "jvm-2.13" / "mdoc")) - sys.error("Have you run mdoc ?") - - val website = os.pwd / "website" - val versionedDocs = "versioned_docs" - val versionedSidebars = "versioned_sidebars" - val versionsJson = "versions.json" - - // Cleanup previous runs - if(os.exists(website / versionedDocs)) os.remove.all(website / versionedDocs) - if(os.exists(website / versionedSidebars)) os.remove.all(website / versionedSidebars) - if(os.exists(website / versionsJson)) os.remove(website / versionsJson) - if(os.exists(website / "pages" / "en" / "versions.js")) os.remove(website / "pages" / "en" / "versions.js") - - website.yarn("install") - // Freezing version - - val version = sys.env.get("GITHUB_REF") - .filter(_.startsWith("refs/tags/v")) - .map(_.drop("refs/tags/v".length)) - .getOrElse(throw new Exception("GITHUB REF doesn't contain a tag!")) - val siteConfig = ujson.read(os.read(website / "siteConfig.json")) - val orgName = siteConfig("organizationName").str - val projectName = siteConfig("projectName").str - val redirectUrl = projectName + "/index.html" - val html = redirectHtml(redirectUrl) - - val currentBranch = git("rev-parse", "--abbrev-ref", "HEAD") - val currentCommit = git("rev-parse", "HEAD") - - val siteBranch = "gh-pages" - val frozenDocsBranch = "frozen-docs" - val githubHost = "github.com" - val remote = s"git@$githubHost:$orgName/$projectName.git" - - val currentRepoURL = git("config", "--get", "remote.origin.url") - - // Restoring frozen docs - log("Restoring frozen docs") - val frozenDocs = os.pwd / "target" / frozenDocsBranch - - - // Dirty hack to avoid docusaurusCreatePages crashing in branch builds - os.copy.over(website / "pages" / "en" / "versions.js_", website / "pages" / "en" / "versions.js") - - if (os.exists(frozenDocs)) os.remove.all(frozenDocs) - - git("clone", "--depth", "1", "--branch", frozenDocsBranch, remote, frozenDocs.toString()) - if(os.exists(frozenDocs / versionedDocs)) os.copy.over(frozenDocs / versionedDocs, website / versionedDocs) - if(os.exists(frozenDocs / versionedSidebars)) os.copy.over(frozenDocs / versionedSidebars, website / versionedSidebars) - if(os.exists(frozenDocs / versionsJson)) os.copy.over(frozenDocs / versionsJson, website / versionsJson) - - // Freezing current version - log("Freezing current version") - website.yarn("run", "version", version) - - // Caching frozen docs - os.copy.over(website / versionedDocs, frozenDocs / versionedDocs) - os.copy.over(website / versionedSidebars, frozenDocs / versionedSidebars) - os.copy.over(website / versionsJson, frozenDocs / versionsJson) - - log(s"pushing to $frozenDocsBranch") - frozenDocs.git("add", "*") - frozenDocs.git("commit", "-m", s"Pushing docs for $version") - frozenDocs.git("push", "origin", frozenDocsBranch) - - log("building site") - website.yarn("run", "build") - val build = website / "build" - os.write(build / "index.html", html) - - log(s"cloning $siteBranch") - val cloneDir = build / siteBranch - if (os.exists(cloneDir)) os.remove.all(cloneDir) - build.git("clone","--depth", "1", "--branch", siteBranch, remote, cloneDir.toString()) - if (os.list(cloneDir).filterNot(_.last == ".git").nonEmpty) cloneDir.git("rm", "-rf", ".") - - val from = build / projectName - val to = cloneDir - - os.list(from).filterNot(_.baseName == ".DS_Store").filterNot(_ == cloneDir).foreach(os.copy.into(_, cloneDir)) - cloneDir.git("add", "*") - cloneDir.git("commit", "-m", "Deploy website", "-m", s"Deploy website version based on $currentCommit") - - log(s"pushing to $siteBranch") - cloneDir.git("push", "origin", siteBranch) - - log("Done !") -} - -def git(args: String*): String = - os.proc("git" :: args.toList).call().out.text() - -implicit class PathOps(path: os.Path) { - def git(args: String*): String = - os.proc("git" :: args.toList).call(path).out.text() - - def yarn(args: String*): String = - os.proc("yarn" :: args.toList).call(path).out.text() -} - -def redirectHtml(url: String): String = { - s""" - | - | - | - | - | - | - | Page Redirection - | - | - | If you are not redirected automatically, follow this link. - | - | - """.stripMargin -} - -def log(s: String) = System.err.println(s"[INFO] $s") - -val installSSHScript: String = - """|#!/usr/bin/env bash - | - |set -eu - | - |set-up-ssh() { - | echo "Setting up ssh..." - | mkdir -p $HOME/.ssh - | ssh-keyscan -t rsa github.com >> ~/.ssh/known_hosts - | git config --global user.name "Docusaurus bot" - | git config --global user.email "${MDOC_EMAIL:-mdoc@docusaurus}" - | git config --global push.default simple - | DEPLOY_KEY_FILE=$HOME/.ssh/id_rsa - | echo "$GITHUB_DEPLOY_KEY" | base64 --decode > ${DEPLOY_KEY_FILE} - | chmod 600 ${DEPLOY_KEY_FILE} - | eval "$(ssh-agent -s)" - | ssh-add ${DEPLOY_KEY_FILE} - |} - |DEPLOY_KEY=${GITHUB_DEPLOY_KEY:-} - | - |if [[ -n "$DEPLOY_KEY" ]]; then - | set-up-ssh - |fi - """.stripMargin - -def doInstallSSH() = { - val tmp = os.temp(contents = installSSHScript, - dir = os.pwd, - prefix = "docusaurus", - suffix = "install_ssh.sh") - os.proc.apply(Seq("chmod", "+x", tmp.toString)) - os.proc.apply(Seq("bash", tmp.toString)).call(cwd = os.pwd) -}