Skip to content

Merging a content based pull request into develop

Jump to bottom
Robert Stringer edited this page Feb 19, 2021 · 2 revisions
  1. Ensure develop is up to date:
git checkout develop
git pull origin develop
  1. Enable all document sources. We'll be building the entire site locally.
yarn config-sources
  1. Review changes on the github PR. If something looks wrong, leave a comment and request changes. Approve the PR before merging it.
  2. Merge feature-branch into develop - the branch name will be in the pull request, there's a little icon that will copy it to clipboard when clicked.
git merge origin/feature-branch
  1. Build site and verify changes
yarn develop

The local build can fail for a number of reasons, common issues relate to unclosed HTML tags, which the MDX parser interprets as bad JSX. If you see error relating to JSX, the files need to be corrected. (Look for unclosed HTML tags, eg <div> without a corresponding </div>

If there are conflicts, these must be resolved and committed. I find that Github desktop and VS Code are good for resolving these. Each conflicted file needs to be resolved.

  1. Push the changes:
git push origin develop
  1. Merging into develop automatically kicks off a build to staging. You may verify the progress of this build by monitoring the github actions page
Clone this wiki locally