Add documentation for build previews with GHA and Netlify

[andersy005]

Towards ProjectPythia/pythia-foundations#85. This PR is related to #167

[jukent]

This reads well but I have not actually tried to follow the steps. I won't have time to do that until next Monday.

Thanks for putting this together @andersy005 !

[github-actions]

This pull request is being automatically built with GitHub Actions and Netlify. To see the status of your deployment, click below.

🔍 Git commit SHA: 52bac9a
✅ Deployment Preview URL: https://616902a18664ff598ecc608a--projectpythia-org.netlify.app

[andersy005]

This pull request is being automatically built with GitHub Actions and Netlify. To see the status of your deployment, click below.

🔍 Git commit SHA: 7523c1a
✅ Deployment Preview URL: 6150e5c66db04c0ad302d500--projectpythia-org.netlify.app

The new GitHub Actions + Netlify workflow is working :).

1. We should update the contributing guide to reflect this change.
2. Readthedocs builds can be disabled.

[brian-rose]

Looks good! A few notes:

• Under "Step 3: Update site settings", I think screenshot 2 out of 3 ought to have a red box around the "Edit settings" button for clarity and consistency
• The example script with the deploy_site workflow is a little bit inconsistent with the actual deploy_site workflow in this repository (projectpythia.github.io/.github/workflows/ci.yaml). The filename is different and some of the details are different.
• Similarly, the example preview_site script is inconsistent with the projectpythia.github.io/.github/workflows/preview.yaml. I think we just need to add the extra if statements that came with Preview PRs via Netlify + GitHub Actions #167
• In "Step 6: Create GitHub Action secrets", can we just clarify that NETLIFY_SITE_ID in the GitHub action is the same thing as API ID in the Netlify site settings.

[jbusecke]

Hey everyone.
First of all thanks a lot for adding these super helpful instructions. I have tried to implement them in a test project here, but keep getting an error that I honestly am not sure how to deal with: Apparently my API_ID has a problem: is not a legal HTTP header value. Could this be because there is absolutely no content on it yet? Do you need to upload a first version manually?

[jbusecke]

~~Quick update: I was indeed able to fix my problem by reactivating the build process and creating a site. I assume there is a better way to do this from the command line though? Maybe just upload a dummy file, so that something is 'there'. ~~
EDIT: This actually did not work (netlify was still building by itself). Does anyone have a hunch of what could be going wrong there?

[andersy005]

EDIT: This actually did not work (netlify was still building by itself). Does anyone have a hunch of what could be going wrong there?

@jbusecke, can you confirm that the auto builds are deactivated here

[jbusecke]

Yep. I turned them off.

[andersy005]

Okay... My next hunch is that when you added your Netlify credentials as GitHub Secrets, you may have inadvertently added a newline at the end of your keys and this ends up messing the HTTP headers during the connection to the Netlify. Can you reset those and re-trigger your GitHub workflow to see if the issue goes away?

[jbusecke]

So I did that, but it also seems as if an older PR (yesterday night) built successfully. I wonder if this was a slip up on the netlify side? Thanks so much for this great tutorial!

[andersy005]

I wonder if this was a slip up on the netlify side? Thanks so much for this great tutorial!

I was about to mention this :) (Just saw logs from your latest, successful builds). Yeah, it's likely a glitch

[kmpaul]

One typo that I could find. I haven't verified that this works, but the text looks good.

[andersy005]

@kmpaul & @brian-rose, I addressed your comments/feedback. Let me know if I missed anything...

[kmpaul]

Thanks, @andersy005!

[jbusecke]

😍