diff --git a/.github/workflows/site.yml b/.github/workflows/site.yml index a9e071b..80effb4 100644 --- a/.github/workflows/site.yml +++ b/.github/workflows/site.yml @@ -1,4 +1,4 @@ -# This file was autogenerated using `zio-sbt-website` via `sbt generateGithubWorkflow` +# This file was autogenerated using `zio-sbt-website` via `sbt generateGithubWorkflow` # task and should be included in the git repository. Please do not edit it manually. name: Website @@ -29,8 +29,6 @@ jobs: check-latest: true - name: Check if the README file is up to date run: sbt docs/checkReadme - - name: Check if the site workflow is up to date - run: sbt docs/checkGithubWorkflow - name: Check artifacts build process run: sbt +publishLocal - name: Check website build process diff --git a/README.md b/README.md index 8b641b0..edec29d 100644 --- a/README.md +++ b/README.md @@ -52,7 +52,7 @@ SamplingProfiler .flatMap(_.stackCollapseToFile("profile.folded")) ``` -The resulting file can be converted to a svg using the flamegraph.pl script ([preview](img/example_sampling_profile.svg)): +The resulting file can be converted to a svg using the flamegraph.pl script ([example](img/example_sampling_profile.svg)): ```bash flamegraph.pl ./examples/profile.folded > profile.svg ``` @@ -102,7 +102,7 @@ CausalProfiler(iterations = 100) .flatMap(_.renderToFile("profile.coz")) ``` -The file can be viewed using the [Coz Visualizer](docs/https://plasma-umass.org/coz/) ([preview](img/example_causal_profile.png)). +The file can be viewed using the [Coz Visualizer](https://plasma-umass.org/coz/) (docs/[example](img/example_causal_profile.png)). As you can see, the profiler correctly tells you that you can get up to a 33% speedup by optimizing the `slow2` effect, but it's impossible to get a speedup any other way. @@ -204,11 +204,11 @@ Learn more on the [ZIO Profiling homepage](https://zio.dev/zio-profiling/)! ## Contributing -For the general guidelines, see ZIO [contributor's guide](https://zio.dev/about/contributing). +For the general guidelines, see ZIO [contributor's guide](https://zio.dev/contributor-guidelines). ## Code of Conduct -See the [Code of Conduct](https://zio.dev/about/code-of-conduct) +See the [Code of Conduct](https://zio.dev/code-of-conduct) ## Support diff --git a/build.sbt b/build.sbt index 0662b75..9ff7765 100644 --- a/build.sbt +++ b/build.sbt @@ -91,6 +91,5 @@ lazy val docs = project projectName := "ZIO Profiling", mainModuleName := (core / moduleName).value, projectStage := ProjectStage.Concept, - docsPublishBranch := "master", ScalaUnidoc / unidoc / unidocProjectFilter := inProjects(core) ) diff --git a/docs/index.md b/docs/index.md index 996bd63..9d22263 100644 --- a/docs/index.md +++ b/docs/index.md @@ -52,7 +52,7 @@ SamplingProfiler .flatMap(_.stackCollapseToFile("profile.folded")) ``` -The resulting file can be converted to a svg using the flamegraph.pl script ([preview](img/example_sampling_profile.svg)): +The resulting file can be converted to a svg using the flamegraph.pl script ([example](img/example_sampling_profile.svg)): ```bash flamegraph.pl ./examples/profile.folded > profile.svg ``` @@ -102,7 +102,7 @@ CausalProfiler(iterations = 100) .flatMap(_.renderToFile("profile.coz")) ``` -The file can be viewed using the [Coz Visualizer](https://plasma-umass.org/coz/) ([preview](img/example_causal_profile.png)). +The file can be viewed using the [Coz Visualizer](https://plasma-umass.org/coz/) ([example](img/example_causal_profile.png)). As you can see, the profiler correctly tells you that you can get up to a 33% speedup by optimizing the `slow2` effect, but it's impossible to get a speedup any other way. diff --git a/project/plugins.sbt b/project/plugins.sbt index 586aebd..dbc02ea 100644 --- a/project/plugins.sbt +++ b/project/plugins.sbt @@ -7,7 +7,7 @@ addSbtPlugin("com.thoughtworks.sbt-api-mappings" % "sbt-api-mappings" % "3.0.2") addSbtPlugin("de.heikoseeberger" % "sbt-header" % "5.10.0") addSbtPlugin("org.scalameta" % "sbt-mdoc" % "2.3.7") addSbtPlugin("org.scalameta" % "sbt-scalafmt" % "2.5.2") -addSbtPlugin("dev.zio" % "zio-sbt-website" % "0.3.10") +addSbtPlugin("dev.zio" % "zio-sbt-website" % "0.4.0-alpha.22") addSbtPlugin("pl.project13.scala" % "sbt-jmh" % "0.4.7") libraryDependencies += "org.snakeyaml" % "snakeyaml-engine" % "2.7"