diff --git a/buildroot/share/git/README.md b/buildroot/share/git/README.md new file mode 100755 index 0000000000..8d985242b3 --- /dev/null +++ b/buildroot/share/git/README.md @@ -0,0 +1,60 @@ +## Marlin Github Helper Scripts + +### Introduction + +A Pull Request is often just the start of a longer process of patching and refining the code until it's ready to merge. In that process it's common to accumulate a lot of commits, some of which are non-functional. Before merging any PR, excess commits need to be "squashed" and sometimes rearranged or reworked to produce a well-packaged set of changes and keep the commit history relatively clean. + +In addition, while a PR is being worked on other commits may be merged, leading to conflicts that need resolution. For this reason, it's a best practice to periodically refresh the PR so the working copy closely reflects the final merge. + +#### Merge vs Rebase + +I recommend not using Github Desktop to sync and merge. Use the command line instead. Github Desktop provides a "merge" option, but for best results "`git rebase`" is recommended. Merge applies new work after your commits. This buries them and makes it hard to bring them together as a final packaged unit. Rebase moves your commits to the end of the branch, ensuring that your commits will be adapted to the current code. This makes it easier to keep revising the commits in-place. + +### The Scripts + +The following scripts can be used on macOS or Linux to speed up the process of working with Marlin and submitting changes to the project. + +#### Remotes + +File|Description +----|----------- +mfadd [user]|Add Remote - Add another Github user's fork of Marlin as a remote, then fetch it. After this you can check out one of their branches and either make a PR targeted at their fork or targeted at `bugfix-1.1.x`. +mfinit|Init Working Copy - Creates a remote named '`upstream`' (for use by the other scripts) pointing to the '`MarlinFirmware`' fork. Use once after checking out your fork. + + +#### Branches + +File|Description +----|----------- +mfnew [branch]|New Branch - Creates a new branch based on `upstream/[PR-target]`. All new work should start here. +firstpush|Push the current branch to 'origin' -your fork on Github- and set it to track '`origin`'. The branch needs to reside on Github before you can use it to make a PR. + + +#### Making / Amending PRs + +File|Description +----|----------- +mfpr|Pull Request - Open the Compare / Pull Request page on Github for the current branch. +mfrb|Do a `git rebase` then `git rebase -i` of the current branch onto `upstream/[PR-target]`. Use this to edit your commits anytime. +mfqp|Quick Patch - Commit all current changes as "patch", `mfrb`, and `git push -f`. + +#### Documentation + +File|Description +----|----------- +mfdoc|Build the documentation and preview it locally. +mfpub|Build the documentation and publish it to marlinfw.org via Github. + +#### Utilities + +File|Description +----|----------- +ghtp -[h/s]|Set the protocol to use for all remotes. -h for HTTPS, -s for SSL. +mfinfo|This utility script is used by the other scripts to get:
- The upstream project ('`MarlinFirmware`')
- the '`origin`' project (i.e., your Github username),
- the repository name ('`Marlin`'),
- the PR target branch ('`bugfix-1.1.x`'), and
- the current branch (or the first command-line argument).

By itself, `mfinfo` simply prints these values to the console. +mfclean     |Prune your merged and remotely-deleted branches. + +--- + +### Examples + +Coming Soon! diff --git a/buildroot/share/git/mfprune b/buildroot/share/git/mfclean similarity index 76% rename from buildroot/share/git/mfprune rename to buildroot/share/git/mfclean index cbf10b0c23..4ce0faa8f5 100755 --- a/buildroot/share/git/mfprune +++ b/buildroot/share/git/mfclean @@ -1,22 +1,24 @@ #!/usr/bin/env bash # -# mfprune +# mfclean # # Prune all your merged branches and any branches whose remotes are gone # Great way to clean up your branches after messing around a lot # +KEEP="RC|RCBugFix|dev|master|bugfix-1" + echo "Fetching latest upstream and origin..." git fetch upstream git fetch origin echo echo "Pruning Merged Branches..." -git branch --merged | egrep -v "^\*|RC|RCBugFix|dev" | xargs -n 1 git branch -d +git branch --merged | egrep -v "^\*|$KEEP" | xargs -n 1 git branch -d echo echo "Pruning Remotely-deleted Branches..." -git branch -vv | egrep -v "^\*|RC|RCBugFix|dev" | grep ': gone]' | gawk '{print $1}' | xargs -n 1 git branch -D +git branch -vv | egrep -v "^\*|$KEEP" | grep ': gone]' | gawk '{print $1}' | xargs -n 1 git branch -D echo echo "You may want to remove (or checkout) these refs..." diff --git a/buildroot/share/git/mfnew b/buildroot/share/git/mfnew index 7f3d7876c0..42f233bf64 100755 --- a/buildroot/share/git/mfnew +++ b/buildroot/share/git/mfnew @@ -15,4 +15,5 @@ case "$#" in * ) echo "Usage: `basename $0` [branch]" 1>&2 ; exit 1 ;; esac -git checkout $TARG -b $BRANCH +git fetch upstream +git checkout upstream/$TARG -b $BRANCH diff --git a/buildroot/share/git/mfpub b/buildroot/share/git/mfpub index d883561bd2..48ddb21dcb 100755 --- a/buildroot/share/git/mfpub +++ b/buildroot/share/git/mfpub @@ -2,7 +2,11 @@ # # mfpub # -# Use Jekyll to publish Marlin Documentation to the HTML site +# Use Jekyll to generate Marlin Documentation, which is then +# git-pushed to Github to publish it to the live site. +# This publishes the current branch, and doesn't force +# changes to be pushed to the 'master' branch. Be sure to push +# any permanent changes to 'master'. # MFINFO=$(mfinfo "$@") || exit @@ -19,23 +23,22 @@ if [[ $ORG != "MarlinFirmware" || $REPO != "MarlinDocumentation" ]]; then fi if [[ $BRANCH == "gh-pages" ]]; then - echo "Can't build from 'gh-pages.' Only the Jekyll branches." + echo "Can't build from 'gh-pages.' Only the Jekyll branches (based on 'master')." bundle exec jekyll serve --watch exit fi if [[ $BRANCH != "master" ]]; then echo "Don't forget to update and push 'master'!" + # GOJF Card + git stash fi +# Check out the named branch (or stay in current) git checkout $BRANCH echo "Generating MarlinDocumentation..." -# GOJF Card -git stash - -TMPFOLDER=$( mktemp -d ) COMMIT=$( git log --format="%H" -n 1 ) # Clean out changes and other junk in the branch @@ -45,19 +48,28 @@ git clean -d -f # Push 'master' to the fork and make a proper PR... if [[ $BRANCH == "master" ]]; then - if [ -z "$(git branch -vv | grep ^\* | grep \\[origin)" ]; then firstpush; fi + if [[ $$FORK == "MarlinFirmware" ]]; then - git push -f origin + # Allow working directly with the main fork + git push -f upstream - TOOL=$(which gnome-open xdg-open open | awk '{ print $1 }') - URL="https://github.com/$ORG/$REPO/compare/$TARG...$FORK:$BRANCH?expand=1" - - if [ -z "$TOOL" ]; then - echo "Can't find a tool to open the URL:" - echo $URL else - echo "Opening a New PR Form..." - "$TOOL" "$URL" + + if [ -z "$(git branch -vv | grep ^\* | grep \\[origin)" ]; then firstpush; fi + + git push -f origin + + TOOL=$(which gnome-open xdg-open open | awk '{ print $1 }') + URL="https://github.com/$ORG/$REPO/compare/$TARG...$FORK:$BRANCH?expand=1" + + if [ -z "$TOOL" ]; then + echo "Can't find a tool to open the URL:" + echo $URL + else + echo "Opening a New PR Form..." + "$TOOL" "$URL" + fi + fi fi @@ -66,9 +78,12 @@ fi # mv ./_plugins/jekyll-press.rb-disabled ./_plugins/jekyll-press.rb # bundle install +# build the site statically and proof it bundle exec jekyll build --profile --trace --no-watch bundle exec htmlproofer ./_site --only-4xx --allow-hash-href --check-favicon --check-html --url-swap ".*marlinfw.org/:/" +# Sync the built site into a temporary folder +TMPFOLDER=$( mktemp -d ) rsync -av _site/ ${TMPFOLDER}/ # Clean out changes and other junk in the branch @@ -84,6 +99,7 @@ git add --all git commit --message "Built from ${COMMIT}" git push upstream +# remove the temporary folder rm -rf ${TMPFOLDER} # Go back to the branch we started from diff --git a/buildroot/share/git/mfrb b/buildroot/share/git/mfrb index b0b7008680..1e7c26e531 100755 --- a/buildroot/share/git/mfrb +++ b/buildroot/share/git/mfrb @@ -13,4 +13,8 @@ case "$#" in * ) echo "Usage: `basename $0`" 1>&2 ; exit 1 ;; esac -git rebase -i ${INFO[3]} +# If the branch isn't currently the PR target +if [[ ${INFO[4]} != ${INFO[5]} ]]; then + git fetch upstream + git rebase upstream/${INFO[3]} && git rebase -i upstream/${INFO[3]} +fi