Skip to content

Commit

Permalink
👷 CI: Update deploy_docs workflow to use alias copy instead of no-r…
Browse files Browse the repository at this point in the history
…edirect

- 💚 Change mike deploy commands in `deploy_docs.yml` to use `--alias-type=copy`
  instead of `--no-redirect` for release, stable, and dev deployments
- 💬 Update `main.html` announcement text with minor wording changes
- ♿️ Set default version in `mkdocs.yml` to 'latest'
  • Loading branch information
abhiTronix committed May 13, 2024
1 parent e119365 commit e497ac2
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 6 deletions.
6 changes: 3 additions & 3 deletions .github/workflows/deploy_docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ jobs:
- name: mike deploy docs release
run: |
echo "${{ env.NAME_RELEASE }}"
mike deploy --push --update-aliases --no-redirect ${{ env.NAME_RELEASE }} ${{ env.RELEASE_NAME }} --title=${{ env.RELEASE_NAME }}
mike deploy --push --update-aliases --alias-type=copy ${{ env.NAME_RELEASE }} ${{ env.RELEASE_NAME }} --title=${{ env.RELEASE_NAME }}
env:
NAME_RELEASE: "v${{ env.RELEASE_NAME }}-release"
if: success()
Expand Down Expand Up @@ -110,7 +110,7 @@ jobs:
- name: mike deploy docs stable
run: |
echo "${{ env.NAME_STABLE }}"
mike deploy --push --update-aliases --no-redirect ${{ env.NAME_STABLE }} latest --title=latest
mike deploy --push --update-aliases --alias-type=copy ${{ env.NAME_STABLE }} latest --title=latest
mike set-default --push latest
env:
NAME_STABLE: "v${{ env.RELEASE_NAME }}-stable"
Expand Down Expand Up @@ -155,7 +155,7 @@ jobs:
- name: mike deploy docs dev
run: |
echo "Releasing ${{ env.NAME_DEV }}"
mike deploy --push --update-aliases --no-redirect ${{ env.NAME_DEV }} dev --title=dev
mike deploy --push --update-aliases --alias-type=copy ${{ env.NAME_DEV }} dev --title=dev
env:
NAME_DEV: "v${{ env.RELEASE_NAME }}-dev"
if: success()
6 changes: 3 additions & 3 deletions docs/overrides/main.html
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@
{% endblock %}
{% block announce %}
<!-- Add announcement here, including arbitrary HTML -->
<b><span class="twemoji"> {% include ".icons/material/message-alert.svg" %} </span> Hey, checkout our new <a
href="https://abhitronix.github.io/deffcode" style="color: yellow; text-decoration: none;">Deffcode</a> library
which will added as vidgear backend soon. We’d love to hear your feedback!</b>
<b><span class="twemoji"> {% include ".icons/material/message-alert.svg" %} </span> We're excited to announce our new <a
href="https://abhitronix.github.io/deffcode" style="color: yellow; text-decoration: none;">Deffcode</a> library,
which will be integrated with VidGear soon. We value your feedback and would love to hear your thoughts!</b>
{% endblock %}
{% block outdated %}
You're not viewing the latest version.
Expand Down
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,7 @@ extra:
link: https://dev.to/abhitronix
version:
provider: mike
default: latest
analytics: # Google analytics
provider: google
property: G-XMZCQ3KBNJ
Expand Down

0 comments on commit e497ac2

Please sign in to comment.