Skip to content

fix(docs): copy aliases instead of symlinks in mike deploy (#413) #45

fix(docs): copy aliases instead of symlinks in mike deploy (#413)

fix(docs): copy aliases instead of symlinks in mike deploy (#413) #45

Workflow file for this run

#
# Build documentation site
#
# NOTES:
# This workflow generates and published the documentation site https://azure.github.io/PSDocs.Azure/.
name: Docs
on:
push:
branches:
- main
workflow_dispatch: {}
permissions: {}
jobs:
deploy:
name: Publish docs
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- name: Checkout
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
fetch-depth: 0
- name: Configure
run: |
git config user.name github-actions
git config user.email '41898282+github-actions[bot]@users.noreply.github.com'
- name: Generate docs
uses: microsoft/ps-docs@333fc57dfef2479e0c6457600bb4c7a1316783ba # main
with:
modules: PSDocs,PSDocs.Azure
inputPath: packages/psdocs-azure/templates
outputPath: docs/templates/
prerelease: true
- name: Setup Python
uses: actions/setup-python@42375524e23c412d93fb67b49958b491fce71c38 # v5.4.0
with:
python-version: '3.9'
architecture: 'x64'
- name: Install dependencies
run: |
python3 -m pip install --upgrade pip
python3 -m pip install wheel
python3 -m pip install -r requirements-docs.txt
- name: Deploy site
# --alias-type=copy: copy v0/ contents into latest/ and stable/ instead of
# creating symlinks. GitHub Pages legacy 'Deploy from a branch' rejects
# symlinks ('Failed to deploy site, please ensure the repository does not
# contain any hard links, symlinks ...'), and using copies keeps the URLs
# /latest/... and /stable/... working without that constraint.
run: mike deploy --push --update-aliases --alias-type=copy v0 latest stable --title 'v0'