-
Notifications
You must be signed in to change notification settings - Fork 17
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
porting documentation changes from series/1.x to series/2.x (#142)
- Loading branch information
Showing
34 changed files
with
363 additions
and
854 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,7 +3,7 @@ name: CI | |
| on: | ||
| pull_request: | ||
| push: | ||
| branches: ['master', 'zio2'] | ||
| branches: ['series/2.x'] | ||
| release: | ||
| types: | ||
| - published | ||
|
|
@@ -46,10 +46,33 @@ jobs: | |
| - name: Run integration tests | ||
| run: sbt -J-XX:+UseG1GC -J-Xmx6g -J-Xms6g -J-Xss16m ++${{ matrix.scala }}! it:test | ||
|
|
||
| mdoc: | ||
| runs-on: ubuntu-20.04 | ||
| timeout-minutes: 30 | ||
| if: github.event_name != 'pull_request' | ||
| steps: | ||
| - name: Checkout current branch | ||
| uses: actions/[email protected] | ||
| - name: Setup Scala and Java | ||
| uses: olafurpg/setup-scala@v13 | ||
| - name: Setup GPG | ||
| uses: olafurpg/setup-gpg@v3 | ||
| - name: Cache scala dependencies | ||
| uses: coursier/cache-action@v6 | ||
| - name: Check Document Generation | ||
| run: ./sbt docs/compileDocs | ||
|
|
||
| ci: | ||
| runs-on: ubuntu-20.04 | ||
| needs: [build, lint, mdoc] | ||
| steps: | ||
| - name: Report successful build | ||
| run: echo "ci passed" | ||
|
|
||
| publish: | ||
| runs-on: ubuntu-20.04 | ||
| timeout-minutes: 30 | ||
| needs: [build,lint] | ||
| needs: [ci] | ||
| if: github.event_name != 'pull_request' | ||
| steps: | ||
| - uses: actions/[email protected] | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,73 @@ | ||
| # 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 | ||
| 'on': | ||
| workflow_dispatch: {} | ||
| release: | ||
| types: | ||
| - published | ||
| push: | ||
| branches: | ||
| - series/2.x | ||
| jobs: | ||
| publish-docs: | ||
| name: Publish Docs | ||
| runs-on: ubuntu-latest | ||
| if: ${{ ((github.event_name == 'release') && (github.event.action == 'published')) || (github.event_name == 'workflow_dispatch') }} | ||
| steps: | ||
| - name: Git Checkout | ||
| uses: actions/[email protected] | ||
| with: | ||
| fetch-depth: '0' | ||
| - name: Setup Scala | ||
| uses: actions/[email protected] | ||
| with: | ||
| distribution: temurin | ||
| java-version: 17 | ||
| check-latest: true | ||
| - name: Setup NodeJs | ||
| uses: actions/setup-node@v3 | ||
| with: | ||
| node-version: 16.x | ||
| registry-url: https://registry.npmjs.org | ||
| - name: Publish Docs to NPM Registry | ||
| run: sbt docs/publishToNpm | ||
| env: | ||
| NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} | ||
| generate-readme: | ||
| name: Generate README | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Git Checkout | ||
| uses: actions/[email protected] | ||
| with: | ||
| ref: ${{ github.head_ref }} | ||
| fetch-depth: '0' | ||
| - name: Setup Scala | ||
| uses: actions/[email protected] | ||
| with: | ||
| distribution: temurin | ||
| java-version: 17 | ||
| check-latest: true | ||
| - name: Generate Readme | ||
| run: sbt docs/generateReadme | ||
| - name: Commit Changes | ||
| run: | | ||
| git config --local user.email "github-actions[bot]@users.noreply.github.com" | ||
| git config --local user.name "github-actions[bot]" | ||
| git add README.md | ||
| git commit -m "Update README.md" || echo "No changes to commit" | ||
| - name: Create Pull Request | ||
| uses: peter-evans/create-pull-request@v4 | ||
| with: | ||
| title: Update README.md | ||
| commit-message: Update README.md | ||
| branch: zio-sbt-website/update-readme | ||
| body: | | ||
| Autogenerated changes after running the `sbt docs/generateReadme` command of the [zio-sbt-website](https://zio.dev/zio-sbt) plugin. | ||
| I will automatically update the README.md file whenever there is new change for README.md, e.g. | ||
| - After each release, I will update the version in the installation section. | ||
| - After any changes to the "docs/index.md" file, I will update the README.md file accordingly. | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -477,3 +477,4 @@ shell.nix | |
| # direnv | ||
| .envrc | ||
| .direnv | ||
| /.vscode/ | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,7 +3,7 @@ import BuildHelper._ | |
| inThisBuild( | ||
| List( | ||
| organization := "dev.zio", | ||
| homepage := Some(url("https://zio.github.io/zio-dynamodb/")), | ||
| homepage := Some(url("https://zio.dev/zio-dynamodb/")), | ||
| licenses := List("Apache-2.0" -> url("http://www.apache.org/licenses/LICENSE-2.0")), | ||
| developers := List( | ||
| Developer( | ||
|
|
@@ -23,7 +23,7 @@ inThisBuild( | |
| pgpPublicRing := file("/tmp/public.asc"), | ||
| pgpSecretRing := file("/tmp/secret.asc"), | ||
| scmInfo := Some( | ||
| ScmInfo(url("https://github.com/googley42/zio-dynamodb"), "scm:git:[email protected]:googley42/zio-dynamodb.git") | ||
| ScmInfo(url("https://github.com/zio/zio-dynamodb"), "scm:git:[email protected]:zio/zio-dynamodb.git") | ||
| ) | ||
| ) | ||
| ) | ||
|
|
@@ -62,7 +62,7 @@ lazy val root = | |
| project | ||
| .in(file(".")) | ||
| .settings(skip in publish := true) | ||
| .aggregate(zioDynamodb, examples) | ||
| .aggregate(zioDynamodb, examples, docs) | ||
|
|
||
| lazy val zioDynamodb = module("zio-dynamodb", "dynamodb") | ||
| .enablePlugins(BuildInfoPlugin) | ||
|
|
@@ -323,10 +323,13 @@ lazy val docs = project | |
| libraryDependencies ++= Seq( | ||
| "dev.zio" %% "zio" % zioVersion | ||
| ), | ||
| unidocProjectFilter in (ScalaUnidoc, unidoc) := inProjects(root), | ||
| target in (ScalaUnidoc, unidoc) := (baseDirectory in LocalRootProject).value / "website" / "static" / "api", | ||
| cleanFiles += (target in (ScalaUnidoc, unidoc)).value, | ||
| docusaurusCreateSite := docusaurusCreateSite.dependsOn(unidoc in Compile).value, | ||
| docusaurusPublishGhpages := docusaurusPublishGhpages.dependsOn(unidoc in Compile).value | ||
| projectName := "ZIO DynamoDB", | ||
| badgeInfo := Some( | ||
| BadgeInfo( | ||
| artifact = "zio-dynamodb_2.12", | ||
| projectStage = ProjectStage.Experimental | ||
| ) | ||
| ), | ||
| docsPublishBranch := "series/2.x" | ||
| ) | ||
| .enablePlugins(MdocPlugin, DocusaurusPlugin, ScalaUnidocPlugin) | ||
| .enablePlugins(WebsitePlugin) | ||
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.