Skip to content

Conversation

@amoeba
Copy link
Member

@amoeba amoeba commented Sep 26, 2025

Creates a new workflow that publishes the docs to Netlify for PRs that touch paths related to the docs. Some things to note:

  • When the deploy runs, a command gets added to the PR (see below)
  • New comments aren't made when the preview is re-deployed
  • The workflow also attaches a "deploy" to the PR so you can click the "View deployment" button (see below) to preview the page
  • This is currently limited to running only on PRs not made from forks. i.e., if you want to update the docs and get previews, you have to push to columnar-tech, not a fork. This is because of the default behavior of secrets and Actions. If we wanted to relax this, we'd need to set up an Environment (I don't have access).

Closes #62

@github-actions
Copy link

github-actions bot commented Sep 26, 2025

@amoeba amoeba changed the title draft: netlify pr previews chore: add workflow to preview docs PRs on Netlify Sep 26, 2025
This reverts commit a49a572.
@amoeba amoeba marked this pull request as ready for review September 26, 2025 21:56
@amoeba amoeba requested a review from ianmcook September 26, 2025 21:57
@amoeba
Copy link
Member Author

amoeba commented Sep 26, 2025

I'm going to try out environments, closing so I can test.

@amoeba amoeba closed this Sep 26, 2025
@amoeba amoeba deleted the netlify-pr-previews branch September 26, 2025 22:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Set up PR deploy previews for docs site

2 participants