v0.6.0 #7
Workflow file for this run
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
# Workflow for updating devdocs.mux.com with new documentation every time a new version is released | |
# | |
# Ths workflow assumes your releases are tagged either "vX.X.X" or "X.X.X", where X is a number of any length | |
# | |
# REQUIRED SECRETS: | |
# AWS_DOCS_KEY | |
# AWS_DOCS_SECRET | |
# DOCS_REPO_PAT | |
# REQUIRED CONFIGURATION: | |
# You have to change 'YOUR-LIB' to match a URL slug for your docs, like 'upload-swift' or 'data-avplayer' | |
name: Upload DocC DevDocs | |
on: | |
release: | |
types: | |
- published | |
jobs: | |
devdocs: | |
runs-on: macos-latest | |
name: Generate and Upload DocC Docs | |
env: | |
AWS_EC2_METADATA_DISABLED: true | |
steps: | |
- uses: actions/checkout@v3 | |
- name: Install xcbeautify | |
run: brew install xcbeautify | |
- name: Parse the version out of the tag name | |
id: version | |
run: | | |
echo "version_name="$(echo ${{ github.event.release.tag_name }} | sed -E "s/^v//")"" >> $GITHUB_OUTPUT | |
- name: Configure AWS | |
run: | | |
aws configure set aws_access_key_id ${{ secrets.AWS_DOCS_KEY }} | |
aws configure set aws_secret_access_key ${{ secrets.AWS_DOCS_SECRET }} | |
- name: Generate Docc | |
env: | |
target_scheme: MuxUploadSDK | |
devdocs_bucket: upload-swift | |
sdk_semantic_version: ${{ steps.version.outputs.version_name }} | |
run: | | |
./scripts/create-docc-archive.sh | |
- name: Update the docs AWS bucket | |
run: | | |
./scripts/upload-to-dev-docs.sh upload-swift ${{ steps.version.outputs.version_name }} | |
- name: Update the devdocs site | |
run: | | |
echo "${{ secrets.DOCS_REPO_PAT }}" | gh auth login --with-token | |
gh workflow run -R muxinc/devdocs-directory deploy-to-s3 |