updated docsite workflow #1624
updated docsite workflow #1624
Conversation
Signed-off-by: Veer0x1 <[email protected]> Signed-off-by: Ry Jones <[email protected]>
ryjones
force-pushed
the
docsite-workflow
branch
from
a60766a to
32a09bd
Compare
done |
| jobs: | ||
| build: | ||
| deplou: |
There was a problem hiding this comment.
| deplou: | |
| deploy: |
| # Strip "v" prefix from tag name | ||
| [[ "${{ github.ref }}" == "refs/tags/"* ]] && ALIAS=$(echo $VERSION | sed -e 's/^v//') | ||
| # If building from main, use latest as ALIAS | ||
| [ "$VERSION" == "main" ] && ALIAS=latest | ||
| echo $VERSION $ALIAS | ||
| mike deploy --push --update-aliases $VERSION $ALIAS | ||
| mike set-default latest |
There was a problem hiding this comment.
Sorry so this issue was about reusing that workflow but I incorrectly made an assumption and now I've realized that this is not the behavior we want. In the previous version, we set latest to be the latest released tag. So as of today v1.3.2 but this new change would make main be latest. Latest is also the default when users land on the page so I think it should stay the newest version as that is version that users should consume
There was a problem hiding this comment.
Based on reading the mike docs https://github.com/jimporter/mike?tab=readme-ov-file I think keeping latest to point a released version instead of main is the correct behavior in my opinion
There was a problem hiding this comment.
FYI @tkuhrt as I know you built this workflow and the plan was to re-use some code instead of FireFly keeping its own. We could do a GitHub dispatch action in the future but based on the above behavior might make sense to keep our own workflow
Proposed changes
Added automated documentation deployment pipeline using GitHub Actions. This workflow automatically builds and deploys documentation when changes are pushed to main branch or when new version tags are created.
Fixes #1593
Types of changes
Please make sure to follow these points
< issue name >egAdded links in the documentation.