From 3a8b8af3a6a20c96ecd601b0b9be7644c4ceb3dc Mon Sep 17 00:00:00 2001 From: Avinder Bahra Date: Sun, 18 Aug 2024 12:00:30 +0100 Subject: [PATCH] docs ci integration --- .github/workflows/site.yml | 8 ++++---- README.md | 6 +++--- build.sbt | 2 +- project/plugins.sbt | 1 + 4 files changed, 9 insertions(+), 8 deletions(-) diff --git a/.github/workflows/site.yml b/.github/workflows/site.yml index 7cc15f37a..91d8bc28d 100644 --- a/.github/workflows/site.yml +++ b/.github/workflows/site.yml @@ -27,10 +27,10 @@ jobs: distribution: temurin java-version: 17 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 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 72117a3e9..f7584802f 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,11 @@ [//]: # (So please do not edit it manually. Instead, change "docs/index.md" file or sbt setting keys) [//]: # (e.g. "readmeDocumentation" and "readmeSupport".) -# ZIO Dynamodb +# ZIO DynamoDB Simple, type-safe, and efficient access to DynamoDB -[![Development](https://img.shields.io/badge/Project%20Stage-Development-green.svg)](https://github.com/zio/zio/wiki/Project-Stages) ![CI Badge](https://github.com/zio/zio-dynamodb/workflows/Continuous%20Integration/badge.svg) [![Sonatype Releases](https://img.shields.io/nexus/r/https/oss.sonatype.org/dev.zio/zio-dynamodb_2.13.svg?label=Sonatype%20Release)](https://oss.sonatype.org/content/repositories/releases/dev/zio/zio-dynamodb_2.13/) [![Sonatype Snapshots](https://img.shields.io/nexus/s/https/oss.sonatype.org/dev.zio/zio-dynamodb_2.13.svg?label=Sonatype%20Snapshot)](https://oss.sonatype.org/content/repositories/snapshots/dev/zio/zio-dynamodb_2.13/) [![javadoc](https://javadoc.io/badge2/dev.zio/zio-dynamodb-docs_2.13/javadoc.svg)](https://javadoc.io/doc/dev.zio/zio-dynamodb-docs_2.13) [![ZIO Dynamodb](https://img.shields.io/github/stars/zio/zio-dynamodb?style=social)](https://github.com/zio/zio-dynamodb) +[![Development](https://img.shields.io/badge/Project%20Stage-Development-green.svg)](https://github.com/zio/zio/wiki/Project-Stages) ![CI Badge](https://github.com/zio/zio-dynamodb/workflows/CI/badge.svg) [![Sonatype Releases](https://img.shields.io/nexus/r/https/oss.sonatype.org/dev.zio/zio-dynamodb_2.13.svg?label=Sonatype%20Release)](https://oss.sonatype.org/content/repositories/releases/dev/zio/zio-dynamodb_2.13/) [![Sonatype Snapshots](https://img.shields.io/nexus/s/https/oss.sonatype.org/dev.zio/zio-dynamodb_2.13.svg?label=Sonatype%20Snapshot)](https://oss.sonatype.org/content/repositories/snapshots/dev/zio/zio-dynamodb_2.13/) [![javadoc](https://javadoc.io/badge2/dev.zio/zio-dynamodb-docs_2.13/javadoc.svg)](https://javadoc.io/doc/dev.zio/zio-dynamodb-docs_2.13) [![ZIO DynamoDB](https://img.shields.io/github/stars/zio/zio-dynamodb?style=social)](https://github.com/zio/zio-dynamodb) ## Introduction @@ -106,7 +106,7 @@ docker compose -f docker/docker-compose.yml down ## Documentation -Learn more on the [ZIO Dynamodb homepage](https://zio.dev/zio-dynamodb/)! +Learn more on the [ZIO DynamoDB homepage](https://zio.dev/zio-dynamodb/)! ## Contributing diff --git a/build.sbt b/build.sbt index dabbb7e75..9107c5cc7 100644 --- a/build.sbt +++ b/build.sbt @@ -340,7 +340,7 @@ lazy val docs = project mainModuleName := (zioDynamodb / moduleName).value, projectStage := ProjectStage.Development, ScalaUnidoc / unidoc / unidocProjectFilter := inProjects(zioDynamodb), - ciWorkflowName := "Continuous Integration", +// ciWorkflowName := "Continuous Integration", libraryDependencies ++= Seq("dev.zio" %% "zio" % zioVersion), publish / skip := true, mdocVariables ++= Map("ZIO_VERSION" -> zioVersion) diff --git a/project/plugins.sbt b/project/plugins.sbt index cedef7ad1..3eee78fbb 100644 --- a/project/plugins.sbt +++ b/project/plugins.sbt @@ -5,3 +5,4 @@ addSbtPlugin("org.scoverage" % "sbt-scoverage" % "2.1.0") addSbtPlugin("ch.epfl.scala" % "sbt-bloop" % "1.6.0") addSbtPlugin("com.github.sbt" % "sbt-ci-release" % "1.5.12") addSbtPlugin("dev.zio" % "zio-sbt-website" % "0.4.0-alpha.28") +addSbtPlugin("dev.zio" % "zio-sbt-ci" % "0.4.0-alpha.28")