Gutenberg: contribute to docs build automation

[bangank36]

Summary

• PR
• There is additional step required when contributing to the /docs folder, see #42375
• This issue is used to explore the necessary steps for submitting the new Actions for Gutenberg

Q & A

What is the detailed step for submitting new docs

• Create a new document

  What blocks the PRs when the manifest.json missing

  Here is an example of a PR where this caused friction: https://togithub.com/WordPress/gutenberg/pull/42276

  You can see the failed static analysis GitHub Action here: https://github.com/WordPress/gutenberg/runs/7254588075?check_suite_focus=true#step:7:33

• It's the step https://github.com/WordPress/gutenberg/actions/runs/2637200095/workflow#L48: npm run check-local-changes, which is handled on this file check-local-changes
• The workflow will run on each PR and push to certain branches

Reference

• #42375
• Suggestion 42375#issuecomment-1198227095

  The commit will get created if the changes need to be applied

  • https://github.com/WordPress/gutenberg/blob/ed5813c1325b8d6a09df7dd1bda00a8d90faf820/.github/workflows/build-plugin-zip.yml#L128-L134
  • automation that happens when different actions get triggered for PRs we could use a unique label or keyword in the comment to manually trigger the GitHub action

[bangank36]

Update

• Attempt 1 failed https://github.com/bangank36/gutenberg/blob/a35f9fa40cd8f18804462e7c2d8b0416fef31919/.github/workflows/static-checks.yml#L42

Missing the author identity https://github.com/WordPress/gutenberg/blob/ed5813c1325b8d6a09df7dd1bda00a8d90faf820/.github/workflows/build-plugin-zip.yml#L101

• Attempt 2 failed

Seems to be the issue with my local, something with permissions

Debuggin with tmate

• Good to read blog
  1. Add this step in the workflow
  2. Open the new PR and check the workflow in Actions screen
  3. Watch for the Setup tmate session
  4. Either click on Web shell for web-based terminal for paste the ssh command below into local terminal (nit: press q to skip to the command screen)
     • Debugger works, keep working
• Looks like current set up did not point to the current branch
  1. git branch returns * (HEAD detached from pull/11/merge)
  2. git show HEAD did not return the latest commit in PR
  3. git show HEAD~{commit_number} not return correct
     • Is it the forked repo issue?
• The detached HEAD is the main issue! By default Checkout action only checkout 01 commit, to fetch all branches and commits use https://github.com/actions/checkout#fetch-all-history-for-all-tags-and-branches
• More info to read
  • Is there a way to push changes with a GitHub action?
  • Push to origin from GitHub action
  • Detached HEAD State
  • Checkout@v2 detached HEAD
    • Attached some solution using git api

[bangank36]

Update

• Want to move selective commits from branch to branch: https://stackoverflow.com/a/46461101
• Detached HEAD issue happens again on PR against Wordpress/gutenberg
• On pull_request_target run npm run docs:build will be against the target branch by default ?!

• The new commit has been created, but there is some extra suspicious merged branch

  • git checkout ${{ github.head_ref }} caused the merged branch - it seems like the default behavior

  

  • Weird commit checked out during pull request trigger

  • Why a merge commit for pull requests?

  • checkout action performing merge commit from incorrect base SHA

  • Current test PR failed because wrong base ( trunk )

Github context value based on event

Assume automation/test-docs-build-1 is head branch automation/rebuild-docs-manifest is based branch

	pull_request_target	pull_request
github.head_ref	automation/test-docs-build-1	automation/test-docs-build-1
github.ref	refs/heads/automation/rebuild-docs-manifest	refs/pull/11/merge
github.event.pull_request.head.ref	automation/test-docs-build-1	automation/test-docs-build-1
github.event.pull_request.base.ref	automation/rebuild-docs-manifest	automation/rebuild-docs-manifest

[bangank36]

Update

• Can we explicit set the ref instead of fetching whole repo? https://github.com/Expensify/App/blob/7cae1dcbf1994703fe88667a9a5c45f4d6e2d844/.github/workflows/createNewVersion.yml#L67
• More detail about accepted ref value, note that when the ref is null it is default to single commit sha , thus leads to the detached HEAD state?

[bangank36]

Staled