Tools: Clean up documentation previews #130
Conversation
Delete preview
|
📚 Documentation Preview ✅ A preview of the documentation changes in this PR is available for maintainers at: Last updated: 2025-01-11 00:42 UTC |
codeallthethingz
added
infrastructure
| runs: | ||
| using: 'composite' | ||
| steps: | ||
| - id: set-vars |
There was a problem hiding this comment.
style: Please change to set_vars to match the existing arbitrary convention.
| export PATH="$HOME/miniconda/bin:$PATH" | ||
| source activate tbp.monty | ||
| echo "monty_version=$(python -m tools.print_version.cli minor)" >> $GITHUB_OUTPUT | ||
| echo "BRANCH_NAME=${{ github.event.pull_request.user.login }}-$(echo ${GITHUB_HEAD_REF} | tr -c '[:alnum:]' '-' | sed 's/-*$//')" >> $GITHUB_OUTPUT |
There was a problem hiding this comment.
note (non-blocking): I wonder if passing in the username as explicit input might be more robust than assuming the github.event.pull_request.user.login will always resolve to something where this action is used.
| cleanup_docs_preview: | ||
| name: cleanup-docs-preview | ||
| runs-on: ubuntu-latest | ||
| if: github.event.pull_request.merged == true |
There was a problem hiding this comment.
issue (non-blocking): It seems to me that even if the pull request was not merged, the cleanup should occur.
| export PATH="$HOME/miniconda/bin:$PATH" | ||
| conda --version | ||
|
|
||
| - name: Create conda environment |
There was a problem hiding this comment.
issue (non-blocking): Is there a way for you to use a cache here? For example:
tbp.monty/.github/workflows/monty.yml
Line 244 in 381f052
| - name: Deploy docs | ||
| working-directory: tbp.monty | ||
| run: | | ||
| export PATH="$HOME/miniconda/bin:$PATH" | ||
| source activate tbp.monty | ||
| export README_API_KEY=${{ secrets.README_API_KEY }} | ||
| export IMAGE_PATH=${{ vars.IMAGE_PATH }} | ||
| python -m tools.github_readme_sync.cli upload docs "${MONTY_VERSION}-${BRANCH_NAME}" | ||
| python -m tools.github_readme_sync.cli upload docs "${{ steps.preview_info.outputs.monty_version }}-${{ steps.preview_info.outputs.branch_name }}" |
|
note to self: Observing documentation preview because |
This PR creates a new action to delete documentation previews from Readme.com.
This PR also changes the naming structure of the preview URLs to namespace with a username prefix.
This branch is called
main2as I was using that as the main branch in my fork to test the PR closing trigger.