From f2d7f14812088cc5170069e24d087771db7ec20c Mon Sep 17 00:00:00 2001 From: Alexey Zimarev Date: Thu, 15 Feb 2024 17:19:53 +0100 Subject: [PATCH] Add action to build docs --- .github/workflows/docs.yml | 41 +++++++++++++++++++++++++++++++++ .github/workflows/preview.yml | 5 ++-- .github/workflows/publish.yml | 2 +- docs/topics/domain/Aggregate.md | 4 ++-- 4 files changed, 47 insertions(+), 5 deletions(-) create mode 100644 .github/workflows/docs.yml diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 00000000..1f3e4636 --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,41 @@ +name: Publish docs + +on: + push: + branches: + - dev + paths: + - 'docs/**' + +env: + INSTANCE: docs/e + ARTIFACT: webHelpE-all.zip + DOCKER_VERSION: 233.14389 + +jobs: + build: + runs-on: ubuntu-latest + steps: + - + name: Checkout repository + uses: actions/checkout@v4 + - + name: Build Writerside docs using Docker + uses: JetBrains/writerside-github-action@v4 + with: + instance: ${{ env.INSTANCE }} + artifact: ${{ env.ARTIFACT }} + docker-version: ${{ env.DOCKER_VERSION }} + - + name: Extract Files + run: 7z x artifacts/${{ env.ARTIFACT }} -ocf-pages + - + name: Publish to Cloudflare Pages + uses: cloudflare/pages-action@v1 + with: + apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }} + accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }} + projectName: eventuous-docs + directory: cf-pages + branch: dev + wranglerVersion: '3' \ No newline at end of file diff --git a/.github/workflows/preview.yml b/.github/workflows/preview.yml index cf8fdb93..e5ea3870 100644 --- a/.github/workflows/preview.yml +++ b/.github/workflows/preview.yml @@ -4,7 +4,8 @@ on: push: branches: - dev - + paths-ignore: + - 'docs/**' jobs: nuget: runs-on: self-hosted @@ -18,7 +19,7 @@ jobs: python-version: 3.8 - name: Checkout code - uses: actions/checkout@v3 + uses: actions/checkout@v4 with: fetch-depth: 0 # - diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index 8fa9ad83..855945eb 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -17,7 +17,7 @@ jobs: python-version: 3.8 - name: Checkout code - uses: actions/checkout@v3 + uses: actions/checkout@v4 with: fetch-depth: 0 - diff --git a/docs/topics/domain/Aggregate.md b/docs/topics/domain/Aggregate.md index bd277e8a..e15b8e18 100644 --- a/docs/topics/domain/Aggregate.md +++ b/docs/topics/domain/Aggregate.md @@ -4,7 +4,7 @@ Find out about abstractions Eventuous provides to implement the pattern, with sa # Aggregate -> From version 0.14.0 using aggregates is **optional**. You can define your domain logic using [functional services](../application/func-service.md) instead. +> From version 0.14.0 using aggregates is **optional**. You can define your domain logic using [functional services](Functional-service.md) instead. > {style="note"} @@ -160,7 +160,7 @@ public record BookingId(string Value) : AggregateId(Value); The abstract record overrides its `ToString` to return the string value as-is. It also has an implicit conversion operator, which allows you to use a string value without explicitly instantiating the identity record. However, we still recommend instantiating the identity explicitly to benefit from type safety. -The aggregate identity type is only used by the [command service](../application/app-service.md) and for calculating the [stream name](../persistence/aggregate-stream.md) for loading and saving events. +The aggregate identity type is only used by the [command service](Command-service.md) and for calculating the [stream name](Event-streams.md) for loading and saving events. ## Aggregate factory