Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 57 additions & 0 deletions .github/workflows/_framework-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
name: Reusable framework docs workflow

on:
workflow_call:
inputs:
build-versioned:
description: "Flag that determines whether all versions of the docs should be built."
required: false
default: false
type: boolean
deploy:
description: "Flag that determines whether the docs should be deployed."
required: false
default: false
type: boolean

permissions:
contents: read

env:
FLWR_TELEMETRY_ENABLED: 0

jobs:
build-and-deploy:
runs-on: ubuntu-22.04
name: Build and deploy
steps:
- uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
with:
fetch-depth: 0
- name: Check copyright line
run: ./dev/test-copyright.sh
- name: Bootstrap
uses: ./.github/actions/bootstrap
- name: Install pandoc
run: sudo apt install pandoc
- name: Install Flower Framework and Flower Datasets with dependencies
working-directory: framework
run: |
python -m poetry add ../datasets
python -m poetry install
- name: Build docs
run: ./dev/build-docs.sh ${{ inputs.build-versioned }}
- name: Copy versioned docs
if: ${{ inputs.build-versioned && inputs.deploy }}
run: cp -r doc/build/html/v* framework/docs/build/html
- name: Deploy docs
if: ${{ inputs.deploy }}
env:
AWS_DEFAULT_REGION: ${{ secrets.DOCS_AWS_DEFAULT_REGION }}
AWS_ACCESS_KEY_ID: ${{ secrets.DOCS_AWS_ACCESS_KEY_ID }}
AWS_SECRET_ACCESS_KEY: ${{ secrets.DOCS_AWS_SECRET_KEY_ID }}
run: |
aws s3 sync --delete --exclude ".*" --exclude "v/*" --cache-control "no-cache" ./framework/docs/build/html/ s3://${{ secrets.DOCS_AWS_BUCKET_NAME }}/docs/framework
aws s3 sync --delete --exclude ".*" --exclude "v/*" --cache-control "no-cache" ./baselines/docs/build/html/ s3://${{ secrets.DOCS_AWS_BUCKET_NAME }}/docs/baselines
aws s3 sync --delete --exclude ".*" --exclude "v/*" --cache-control "no-cache" ./examples/docs/build/html/ s3://${{ secrets.DOCS_AWS_BUCKET_NAME }}/docs/examples
aws s3 sync --delete --exclude ".*" --exclude "v/*" --cache-control "no-cache" ./datasets/docs/build/html/ s3://${{ secrets.DOCS_AWS_BUCKET_NAME }}/docs/datasets
25 changes: 25 additions & 0 deletions .github/workflows/framework-docs-versioned.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: Framework Docs Manually

on:
workflow_dispatch:
inputs:
build-versioned:
description: "Flag that determines whether all versions of the docs should be built."
required: false
default: false
type: boolean
deploy:
description: "Flag that determines whether the docs should be deployed."
required: false
default: false
type: boolean

jobs:
build-and-deploy-manually:
name: Build and deploy manually
if: github.repository == 'adap/flower'
uses: ./.github/workflows/_framework-docs.yml
with:
build-versioned: ${{ inputs.build-versioned }}
deploy: ${{ inputs.deploy }}
secrets: inherit
40 changes: 6 additions & 34 deletions .github/workflows/framework-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,39 +12,11 @@ concurrency:
group: ${{ github.workflow }}-${{ github.ref == 'refs/heads/main' && github.run_id || github.event.pull_request.number || github.ref }}
cancel-in-progress: true

env:
FLWR_TELEMETRY_ENABLED: 0

jobs:
build_and_deploy:
runs-on: ubuntu-22.04
build-and-deploy:
name: Build and deploy
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Check copyright line
run: ./dev/test-copyright.sh
- name: Bootstrap
uses: ./.github/actions/bootstrap
- name: Install pandoc
run: sudo apt install pandoc
- name: Install Flower Framework and Flower Datasets with dependencies
run: |
cd framework
python -m poetry add ../datasets
python -m poetry install
- name: Build docs
run: ./dev/build-docs.sh ${{ github.ref == 'refs/heads/main' && github.repository == 'adap/flower' && !github.event.pull_request.head.repo.fork }}
- name: Deploy docs
if: ${{ github.ref == 'refs/heads/main' && github.repository == 'adap/flower' && !github.event.pull_request.head.repo.fork }}
env:
AWS_DEFAULT_REGION: ${{ secrets.DOCS_AWS_DEFAULT_REGION }}
AWS_ACCESS_KEY_ID: ${{ secrets.DOCS_AWS_ACCESS_KEY_ID }}
AWS_SECRET_ACCESS_KEY: ${{ secrets.DOCS_AWS_SECRET_KEY_ID }}
run: |
cp -r doc/build/html/v* framework/docs/build/html
aws s3 sync --delete --exclude ".*" --exclude "v/*" --cache-control "no-cache" ./framework/docs/build/html/ s3://${{ secrets.DOCS_AWS_BUCKET_NAME }}/docs/framework
aws s3 sync --delete --exclude ".*" --exclude "v/*" --cache-control "no-cache" ./baselines/docs/build/html/ s3://${{ secrets.DOCS_AWS_BUCKET_NAME }}/docs/baselines
aws s3 sync --delete --exclude ".*" --exclude "v/*" --cache-control "no-cache" ./examples/docs/build/html/ s3://${{ secrets.DOCS_AWS_BUCKET_NAME }}/docs/examples
aws s3 sync --delete --exclude ".*" --exclude "v/*" --cache-control "no-cache" ./datasets/docs/build/html/ s3://${{ secrets.DOCS_AWS_BUCKET_NAME }}/docs/datasets
if: github.repository == 'adap/flower'
uses: ./.github/workflows/_framework-docs.yml
with:
deploy: ${{ github.ref == 'refs/heads/main' && github.repository == 'adap/flower' && !github.event.pull_request.head.repo.fork }}
secrets: inherit
Loading