documentation: render, then publish to GitHub pages (or somewhere else)

[ijlyttle]

A lot of times, I will want to render for pull-requests (make sure it still renders) but deploy only on changes to main (having merged a PR).

Would you consider a PR for documentation?

Something like:

      - name: Render Quarto
        uses: quarto-dev/quarto-actions/render@v2

      - name: Publish to GitHub Pages
        if: github.event_name != 'pull_request'
        uses: quarto-dev/quarto-actions/publish@v2
        with:
          render: false
          target: gh-pages
          env:
            GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # this secret is always available for github actions

Thanks!

[cscheid]

Just to make sure I understand: you want the render action simply to flag for errors.

One of the items in our roadmap is a GHA setup that includes PR previews, since often you won't see an error, but you will see some rendered output you don't like. What you're suggesting might be a workaround, although I think people will expect the PR preview even in that case.

(Like I mentioned in the other issue: documentation is tricky. Let me get back to you on that.)

[ijlyttle]

Yes - just to let me know if the PR renders, so that main can remain "good" at all times (for some value of "good").

I will look forward to see what you come up for PR reviews!

Just like in the other issue, please close this (or not) in accordance with how you like to keep things organized :)

Regardless, I remain happy to help, should the time come.