Skip to content
New issue

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

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

Already on GitHub? # to your account

Feature request: Partial upload/deploy #349

Open
joshlf opened this issue May 23, 2024 · 1 comment
Open

Feature request: Partial upload/deploy #349

joshlf opened this issue May 23, 2024 · 1 comment

Comments

@joshlf
Copy link

joshlf commented May 23, 2024

TLDR: Can this Action support this workflow natively?

My project currently uses this configuration to publish to GitHub Pages from the main branch:

      - name: Upload Cargo doc output to GitHub Pages
        uses: actions/upload-pages-artifact@v3
        with:
          path: target/doc
  deploy:
    name: Deploy to GitHub Pages
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    needs: build
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4

This generates rustdoc and then uploads the generated files to GitHub Pages.

I'm hoping to extend our GitHub pages to also upload a copy of the generated rustdoc for each in-flight PR so that we can preview what the docs will look like. I believe this should be possible with only a small addition to this Action: namely, the ability to specify a target subdirectory when deploying an artifact. This should in theory only require one extra input to the Action:

    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4
        target: a/b/c

The target input would be optional, and default to .. It would instruct the Action to overwrite not necessarily the entire deployment, but a specific subdirectory of the deployment. This would allow us to write something like:

    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4
        target: pulls/${{ ... }}

...and invoke this from a workflow triggered by each PR.

@sergio-bobillier
Copy link

I have a similar use case just with YARD documentation and I would also like to upload an HTML Tests and Coverage report.

Right now I'm just re-running the tests in my "Generate Documentation" action but I'd rather upload these things from my normal "RSpec Tests" action (on merge).

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants