From 6d79f53c34e2ef34409ba26d897280054366fd3f Mon Sep 17 00:00:00 2001 From: Elias Kosunen Date: Wed, 23 Oct 2024 23:22:39 +0300 Subject: [PATCH] Update documentation workflow --- .github/workflows/docs.yml | 30 ++++++++++++++++++++++++++++-- CHANGELOG.md | 3 ++- 2 files changed, 30 insertions(+), 3 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 0ffbbb5d..cb825a0d 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -30,18 +30,44 @@ jobs: - name: Checkout uses: actions/checkout@v4 + with: + fetch-depth: 0 + + - name: Prepare repository (on push) + if: ${{ github.event_name == 'push' }} + run: | + git fetch origin ${{ github.ref_name }}:refs/remotes/origin/${{ github.ref_name }} --tags --force + git remote set-head origin -a + git checkout ${{ github.ref_name }} + git pull --force + + - name: Prepare repository (on release) + if: ${{ github.event_name == 'release' }} + run: | + git fetch origin master:refs/remotes/origin/master --tags --force + git remote set-head origin -a + git checkout ${{ github.ref_name }} + git pull --force + + - name: Prepare repository (on workflow_dispatch) + if: ${{ github.event_name == 'workflow_dispatch' }} + run: | + git fetch origin ${{ github.ref_name }}:refs/remotes/origin/${{ github.ref_name }} --tags --force + git remote set-head origin -a + git checkout ${{ github.ref_name }} + git pull --force - name: Generate docs run: | cd docs - poxy --verbose + poxy --verbose --git-tags --min-version v2.0.0 --no-squash-patches - name: Deploy uses: peaceiris/actions-gh-pages@v3 with: github_token: ${{ secrets.GITHUB_TOKEN }} publish_dir: ./docs/html - destination_dir: ${{ github.ref_name }} + keep_files: true user_name: 'github-actions[bot]' user_email: 'github-actions[bot]@users.noreply.github.com' commit_message: Update documentation (GitHub actions deploy) diff --git a/CHANGELOG.md b/CHANGELOG.md index 663a61f2..c6ae37dc 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,7 +4,8 @@ _Released 2024-xx-xx_ -* Fix formatting options of user-defined types sometimes being ignored + * Fix formatting options of user-defined types sometimes being ignored + * Update documentation to have a version-dropdown ## 3.0.1