Skip to content

docs: Updated module docs with latest versions. (#35) #17

docs: Updated module docs with latest versions. (#35)

docs: Updated module docs with latest versions. (#35) #17

Workflow file for this run

name: Deploy documentation
on:
push:
branches:
- main
jobs:
deploy:
name: Deploy Documentation
environment: 'docs-dev'
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
submodules: true
- name: Copy assets from submodules
run: rsync -av --progress */**/docs/assets/ docs/assets --exclude .git --exclude .idea --exclude docs
- name: Set up AWS credentials
uses: aws-actions/configure-aws-credentials@v4
with:
aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
aws-region: us-east-1
- uses: actions/setup-python@v5
with:
python-version: 3.x
- name: Install packages
run: sudo apt-get update && sudo apt-get install -y plantuml
- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
- uses: actions/cache@v4
with:
key: mkdocs-material-${{ env.cache_id }}
path: .cache
restore-keys: |
mkdocs-material-
- run: pip install mkdocs-material markdown-callouts mkdocs-nav-weight pymdown-extensions plantuml_markdown
- run: mkdocs build
- run: aws s3 sync ./site "s3://${{ env.BUCKET_NAME || 'dev.docs.cfa.codes' }}/${{ env.PREFIX || 'tofu-modules' }}"