From 0e5cee43de9df492da46a0f39ff6d047482e556c Mon Sep 17 00:00:00 2001 From: Matthew Bain <66839492+rocketstack-matt@users.noreply.github.com> Date: Fri, 18 Oct 2024 12:04:40 +0100 Subject: [PATCH] Update docs to publish to calm.finos.org via s3 and configure to use Git LFS for .mov files. (#493) --- .gitattributes | 1 + .github/workflows/s3-docs-sync.yml | 38 ++++++++++++++++++++++++ docs/docusaurus.config.js | 4 +-- docs/static/video/aasc-wg-2024-09-24.mov | 3 ++ 4 files changed, 44 insertions(+), 2 deletions(-) create mode 100644 .gitattributes create mode 100644 .github/workflows/s3-docs-sync.yml create mode 100644 docs/static/video/aasc-wg-2024-09-24.mov diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 00000000..79c18822 --- /dev/null +++ b/.gitattributes @@ -0,0 +1 @@ +*.mov filter=lfs diff=lfs merge=lfs -text diff --git a/.github/workflows/s3-docs-sync.yml b/.github/workflows/s3-docs-sync.yml new file mode 100644 index 00000000..0d41b4a3 --- /dev/null +++ b/.github/workflows/s3-docs-sync.yml @@ -0,0 +1,38 @@ +name: Sync Docs to S3 + +on: + workflow_dispatch: {} + push: + branches: [ "main" ] + paths: [ "docs/**" ] + +jobs: + sync-to-s3: + runs-on: ubuntu-latest + defaults: + run: + working-directory: docs + + steps: + - name: Checkout repository + uses: actions/checkout@v4 + + - uses: actions/setup-node@v4 + with: + node-version: 18 + cache: npm + cache-dependency-path: ./docs/package-lock.json + - name: Install dependencies + run: npm ci + - name: Build website + run: npm run build + + - name: Configure AWS credentials + uses: aws-actions/configure-aws-credentials@v4 + with: + aws-access-key-id: ${{ secrets.AWS_S3_ACCESS_KEY }} + aws-secret-access-key: ${{ secrets.AWS_S3_SECRET_ACCESS_KEY }} + aws-region: us-east-1 + - name: Sync docs to S3 + run: | + aws s3 sync docs/build s3://calm.finos.org/ --delete --include "*" --exclude "draft/*" --exclude "samples/*" diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index 0bfc2373..9f868514 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -13,10 +13,10 @@ const config = { favicon: 'img/favicon.ico', // Set the production url of your site here - url: 'https://rocketstack-matt.github.io/', + url: 'https://calm.finos.org/', // Set the // pathname under which your site is served // For GitHub pages deployment, it is often '//' - baseUrl: '/architecture-as-code/', + baseUrl: '/', // GitHub pages deployment config. // If you aren't using GitHub pages, you don't need these. diff --git a/docs/static/video/aasc-wg-2024-09-24.mov b/docs/static/video/aasc-wg-2024-09-24.mov new file mode 100644 index 00000000..f2b7fb2f --- /dev/null +++ b/docs/static/video/aasc-wg-2024-09-24.mov @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:05c62613f9ec8b6c0dde334dddfee4b3969d42e1ecd4294ecfc31a4afbdef5b2 +size 182137055