updated version on getstarted.md #29
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
| name: publish-doc | |
| on: | |
| push: | |
| branches: | |
| - main | |
| - 'release-v*.*.*' | |
| jobs: | |
| publish-docs: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| persist-credentials: true | |
| - name: Set up Python | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: '3.x' | |
| - name: Configure git | |
| run: | | |
| git config --global user.email "[email protected]" | |
| git config --global user.name "ci-bot" | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install mkdocs-material mike | |
| - name: Deploy to Mike | |
| run: | | |
| if [[ ${{ github.ref }} == refs/heads/main ]]; then | |
| # Deploy to the mike doc version `dev` and update the `latest` alias for the main branch new git commits | |
| mike deploy dev latest --update-aliases --push | |
| mike set-default latest | |
| elif [[ ${{ github.ref }} == refs/heads/release-v* ]]; then | |
| # Deploy to the mike doc version `vx.x.x` for the new git branches `release-vx.x.x` | |
| branch_name=${{ github.ref }} | |
| version=${branch_name##refs/heads/release-} | |
| mike deploy $version --push | |
| fi |