Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add built documentation ZIP file artifact upload to CI workflow #1320

Open
prjemian opened this issue Nov 2, 2023 · 0 comments
Open

add built documentation ZIP file artifact upload to CI workflow #1320

prjemian opened this issue Nov 2, 2023 · 0 comments
Labels
documentation workflows Continuous integration and deployment

Comments

@prjemian
Copy link
Contributor

prjemian commented Nov 2, 2023

As demonstrated elsewhere, upload a ZIP-file copy of the just-built documentation with each run of the CI workflow by adding these two steps.

This step should be added early in the workflow:

    - name: Set env vars
      run: |
        export REPOSITORY_NAME=${GITHUB_REPOSITORY#*/}  # just the repo, as opposed to org/repo
        echo "REPOSITORY_NAME=${REPOSITORY_NAME}" >> $GITHUB_ENV

This step should be added just before the deploy step in the workflow:

    - name: Upload Docs ZIP file as artifact
      uses: actions/upload-artifact@v3
      with:
        name: ${{ env.REPOSITORY_NAME }}-docs
        path: docs/build/html/
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation workflows Continuous integration and deployment
Projects
None yet
Development

No branches or pull requests

1 participant