How to properly commit in repository with Github Pages branch

by

I have a pair of scripts that do exactly this. In my situation, doc sources are in . (relative to where the scripts are run, of course), generated documentation is in _build/html, and I issue the commands

touch _build/html/.nojekyll    # disable GitHub's Jekyll page generator
./commit-to-gh-pages.sh _build/html

where commit-to-gh-pages.sh is

#! /bin/sh

# Commit the generated HTML pages to the branch gh-pages.
# Will not push them to GitHub.

set -e -v

treehash=$(./hash-tree.py "${1:-_build/html}")
parent=$(git rev-parse gh-pages)

msg="Regenerated docs for $(git rev-parse HEAD)"
commithash=$(echo "$msg" | git commit-tree $treehash -p $parent)
echo "Updating gh-pages to $commithash"
git update-ref refs/heads/gh-pages "$commithash"

This writes the directory _build/html to the Git index, makes a commit object that has exactly this directory tree as its contents, and writes the commit object to the gh-pages branch with the previous state of that branch as the parent.

The tricky part is the hash-tree.py script, which extends the git hash-object command to directory trees. I won’t copy-paste it, but you can get it here. (If anyone knows a more elegant way to do this, please tell me.)

More Related Contents:

  1. How can I remove a commit on GitHub? [duplicate]
  2. Git push requires username and password
  3. What is the difference between origin and upstream on GitHub?
  4. Pull new updates from original GitHub repository into forked GitHub repository
  5. Updating a local repository with changes from a GitHub repository
  6. How to git-cherry-pick only changes to certain files?
  7. Link to the issue number on GitHub within a commit message
  8. What is the best practice for dealing with passwords in git repositories?
  9. git ahead/behind info between master and branch?
  10. GitHub “fatal: remote origin already exists”
  11. How to remove sensitive data from a file in github history
  12. Github remote push pack size exceeded
  13. Git’s famous “ERROR: Permission to .git denied to user”
  14. GitHub clone from pull request?
  15. Jenkins – how to build a specific branch
  16. Search code inside a Github project
  17. Why does “git push main” work on GitHub when “git push master” does not? Also what is difference between “Main branch” and “Master branch”?
  18. Error when “git push” to github
  19. To use on Visual Studio Code, but show “Could not read from remote repository.”
  20. How to protect “master” in github?
  21. Is there a way in git to obtain a push date for a given commit?
  22. GitHub changes repository to the wrong language
  23. Why does git revert complain about a missing -m option?
  24. git rebase merge conflict
  25. Github API – create branch?
  26. Can a project have multiple origins?
  27. Error “Your push would publish a private email address”
  28. git push error: src refspec main does not match any on linux
  29. How to manage multiple ssh keys in the ~/.ssh directory
  30. How to pull remote branch from somebody else’s repo

Leave a Comment