Make docs-build action work and push to the PR branch

[srt32]

Follow up to #252

The previous attempt was broken. To avoid branch protection rule errors on main, now we commit the changes to the current PR branch (on push). We can choose to make this build required once we're happy with it so devs can't forget to commit the docs and also can't write broken docs.

[vercel]

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/primer/view-components/9LzkADDTNiGdXk3a4s8FC1FqBQCW
✅ Preview: https://view-components-git-srt32-patch-1-primer.vercel.app

[srt32]

Aha, protected branches are going to be a problem with this approach:

Changes not staged for commit:
  (use "git add <file>..." to update what will be committed)
  (use "git restore <file>..." to discard changes in working directory)
	modified:   Gemfile.lock

no changes added to commit (use "git add" and/or "git commit -a")
remote: error: GH006: Protected branch update failed for refs/heads/main.        
remote: error: 9 of 10 required status checks have not succeeded: 1 expected. At least 1 approving review is required by reviewers with write access.      

[srt32]

We could build the docs on a different branch (docs, for example) and push there?

[srt32]

cc/ @manuelpuyol for thoughts? ^

[manuelpuyol]

Is it possible to commit to the branch that triggered the workflow? That way we could make it run on PRs instead of pushes on main

[srt32]

Is it possible to commit to the branch that triggered the workflow? That way we could make it run on PRs instead of pushes on main

We could totally do this but it means devs will need to git pull before adding more commits, which might be fine but surprising. Let's start there!

implemented in b97c75c

[srt32]

It's alive!

[srt32]

@manuelpuyol ready for another 👁️