⬆️ updated git-update-ghpages script
This commit is contained in:
Niels Lohmann
parent
9eb5e2c271
commit
106f9f5436
2 changed files with 174 additions and 202 deletions
|
|
@ -63,7 +63,7 @@ doxygen: create_output create_links
|
||||||
$(SED) -i 's@< ObjectType, ArrayType, StringType, BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType, AllocatorType, JSONSerializer >@@g' html/*.html
|
$(SED) -i 's@< ObjectType, ArrayType, StringType, BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType, AllocatorType, JSONSerializer >@@g' html/*.html
|
||||||
|
|
||||||
upload: clean doxygen check_output
|
upload: clean doxygen check_output
|
||||||
cd html ; ../scripts/git-update-ghpages nlohmann/json
|
scripts/git-update-ghpages nlohmann/json html
|
||||||
rm -fr html
|
rm -fr html
|
||||||
open http://nlohmann.github.io/json/
|
open http://nlohmann.github.io/json/
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,221 +1,193 @@
|
||||||
#!/usr/bin/env ruby
|
#!/usr/bin/env bash
|
||||||
# git update-ghpages user/repo -b gh-pages -p manual/ -i
|
set -o errexit
|
||||||
|
|
||||||
require 'fileutils'
|
copy_contents() {
|
||||||
require 'tmpdir'
|
local source="$1"
|
||||||
|
status "Copying contents from $source"
|
||||||
module Params
|
if [[ ! "$dryrun" == "1" ]]; then
|
||||||
def extract(what) i = index(what) and slice!(i, 2)[1] end;
|
(cd "$source" >/dev/null && tar c .) | tar xv
|
||||||
def first_is(what) shift if what.include?(self.first); end
|
|
||||||
def self.[](*what) what.extend Params; end
|
|
||||||
def ===(argv) argv.first_is(self); end
|
|
||||||
end
|
|
||||||
|
|
||||||
# ============================================================================
|
|
||||||
|
|
||||||
ARGV.extend Params
|
|
||||||
|
|
||||||
class CLI
|
|
||||||
# CLI options
|
|
||||||
attr_reader :prefix #=> "doc/"
|
|
||||||
attr_reader :input #=> "/home/me/projects/foo"
|
|
||||||
attr_reader :message #=> "Updated"
|
|
||||||
attr_reader :repo #=> "git@github.com:me/project.git"
|
|
||||||
attr_reader :url #=> "http://me.github.com/project"
|
|
||||||
attr_reader :branch #=> "gh-pages"
|
|
||||||
|
|
||||||
def verbose?() @verbose; end
|
|
||||||
def force?() @force; end
|
|
||||||
def simulate?() @simulate; end
|
|
||||||
|
|
||||||
def initialize
|
|
||||||
# Switches
|
|
||||||
@verbose = !! (ARGV.extract('--verbose') || ARGV.delete('-v'))
|
|
||||||
@simulate = !! (ARGV.extract('--simulate') || ARGV.delete('-s'))
|
|
||||||
@force = !! (ARGV.delete('--force') || ARGV.delete('-f'))
|
|
||||||
|
|
||||||
# Stuff
|
|
||||||
@prefix = ARGV.extract('--prefix') || ARGV.extract('-p') || ''
|
|
||||||
@input = File.expand_path(ARGV.extract('--input') || ARGV.extract('-i') || '.')
|
|
||||||
@message = ARGV.extract('--message') || ARGV.extract('-m') || 'Update'
|
|
||||||
|
|
||||||
# Github info
|
|
||||||
branch = ARGV.extract('--branch') || ARGV.extract('-b') || nil
|
|
||||||
@repo, @url, @branch = get_github_info(ARGV.shift, branch)
|
|
||||||
end
|
|
||||||
|
|
||||||
def git_current_branch
|
|
||||||
`git rev-parse --abbrev-ref HEAD`.strip
|
|
||||||
end
|
|
||||||
|
|
||||||
def git_deploy
|
|
||||||
in_temp_path do |temppath|
|
|
||||||
status "Cloning repository"
|
|
||||||
system! "git clone #{repo} -b #{branch} #{temppath}"
|
|
||||||
|
|
||||||
if git_current_branch != branch
|
|
||||||
status "Warning: No #{branch} branch found in repo, creating one."
|
|
||||||
return git_deploy_force
|
|
||||||
end
|
|
||||||
|
|
||||||
copy_files input, File.join(temppath, prefix)
|
|
||||||
|
|
||||||
status "Committing files"
|
|
||||||
system! "git add .; git add -u; git commit -m #{message.to_s.inspect}"
|
|
||||||
|
|
||||||
unless simulate?
|
|
||||||
status "Updating repo"
|
|
||||||
system! "git push origin #{branch}"
|
|
||||||
end
|
|
||||||
true
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
def git_deploy_force
|
|
||||||
in_temp_path do |temppath|
|
|
||||||
status "Creating new repository"
|
|
||||||
system! "git init ."
|
|
||||||
system! "git checkout -b gh-pages"
|
|
||||||
|
|
||||||
copy_files input, File.join(temppath, prefix)
|
|
||||||
|
|
||||||
status "Committing files"
|
|
||||||
system! "git add . && git commit -m #{message.to_s.inspect}"
|
|
||||||
|
|
||||||
unless simulate?
|
|
||||||
status "Updating repo"
|
|
||||||
system! "git push #{repo} gh-pages:#{branch} --force"
|
|
||||||
end
|
|
||||||
true
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
def get_github_info(repo, branch=nil, prefix=nil)
|
|
||||||
if github_format?(repo)
|
|
||||||
user, repo_name = repo.split('/')
|
|
||||||
r = "git@github.com:#{repo}.git"
|
|
||||||
|
|
||||||
# User page or project page?
|
|
||||||
if repo_name =~ /\.github\.com/
|
|
||||||
[r, "http://#{repo_name}/#{prefix}", branch || 'master' ]
|
|
||||||
else
|
else
|
||||||
[r, "http://#{user}.github.com/#{repo_name}/#{prefix}", branch || 'gh-pages' ]
|
_ "(cd \"$source\" >/dev/null && tar c .) | tar xv"
|
||||||
end
|
fi
|
||||||
else
|
}
|
||||||
[repo, nil, branch]
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
def run!
|
# Sets git config
|
||||||
unless repo
|
set_config() {
|
||||||
print_help
|
if [ -n "$GIT_NAME" ]; then _ git config user.name "$GIT_NAME"; fi
|
||||||
exit 128
|
if [ -n "$GIT_EMAIL" ]; then _ git config user.email "$GIT_EMAIL"; fi
|
||||||
end
|
}
|
||||||
|
|
||||||
status "Deploying to #{repo} (branch #{branch})"
|
# Runs the deployment
|
||||||
msg "NOTE: Running in simulation mode." if simulate?
|
run() {
|
||||||
msg "WARNING: If the repository has gh-pages history, it with be overriden." if force? && !simulate?
|
if [ ! -d "$source" ]; then
|
||||||
|
echo "Source is not a directory: $source"
|
||||||
result = force? ? git_deploy_force : git_deploy
|
|
||||||
|
|
||||||
if result
|
|
||||||
puts ""
|
|
||||||
status "Done."
|
|
||||||
msg "See: #{url}" if url && !simulate?
|
|
||||||
else
|
|
||||||
tip "Failed."
|
|
||||||
exit 1
|
exit 1
|
||||||
end
|
fi
|
||||||
end
|
|
||||||
|
|
||||||
def status(str)
|
local tmpdir="$(mktemp -d)"
|
||||||
puts "#{c('===>',34)} #{c(str, 32)}"
|
|
||||||
end
|
|
||||||
|
|
||||||
def msg(str)
|
if [[ "$force" == "1" ]]; then
|
||||||
puts " #{c(str, 32)}"
|
_ cd "$tmpdir"
|
||||||
end
|
_ git init
|
||||||
|
_ git checkout -b "$branch"
|
||||||
|
copy_contents "$source"
|
||||||
|
if [[ "$useenv" == "1" ]]; then set_config; fi
|
||||||
|
_ git add -A .
|
||||||
|
git_commit
|
||||||
|
git_push --force
|
||||||
|
else
|
||||||
|
_ cd "$tmpdir"
|
||||||
|
_ git clone "$repo" . -b "$branch" || ( \
|
||||||
|
_ git init && \
|
||||||
|
_ git checkout -b "$branch")
|
||||||
|
if [[ "$keep" == "0" ]]; then _ rm -rf ./*; fi
|
||||||
|
copy_contents "$source"
|
||||||
|
if [[ "$useenv" == "1" ]]; then set_config; fi
|
||||||
|
_ git add -A .
|
||||||
|
git_commit || true
|
||||||
|
git_push
|
||||||
|
fi
|
||||||
|
_ rm -rf "$tmpdir"
|
||||||
|
status_ "Done"
|
||||||
|
}
|
||||||
|
|
||||||
def c(str, color)
|
git_commit() {
|
||||||
"\033[#{color}m#{str}\033[0m"
|
if [ -z "$author" ]; then
|
||||||
end
|
_ git commit -m "$message"
|
||||||
|
else
|
||||||
|
_ git commit -m "$message" --author "$author"
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
def print_help
|
git_push() {
|
||||||
tip \
|
if [ -z "$GITHUB_TOKEN" ]; then
|
||||||
%{Usage: git update-ghpages username/repository [options]
|
_ git push "${repo}" "$branch" "$@"
|
||||||
|
else
|
||||||
|
status "Pushing via \$GITHUB_TOKEN $@"
|
||||||
|
_ git push "https://${GITHUB_TOKEN}@github.com/${repospec}.git" "$branch" "$@" \
|
||||||
|
--quiet >/dev/null 2>&1 || \
|
||||||
|
( status_ "Failed to push"; exit 1 )
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
Flags:
|
status() {
|
||||||
-f, --force Force an update (WARNING: kills the history!)
|
echo -e "\n\033[34m==>\033[0;1m" "$@\033[0m"
|
||||||
-s, --simulate Creates the repository, but doesn't push.
|
}
|
||||||
-v, --verbose Verbose mode
|
status_() {
|
||||||
|
echo -e "\033[33;1m==>\033[0m" "$@"
|
||||||
|
}
|
||||||
|
|
||||||
Options:
|
_() {
|
||||||
-p PATH, --prefix The prefix
|
echo ""
|
||||||
-i PATH, --input Input (defaults to current directory)
|
status_ "$@"
|
||||||
-b BRANCH, --branch The branch to deploy to (defaults to gh-pages)
|
if [[ ! "$dryrun" == "1" ]]; then "$@"; fi
|
||||||
-m MSG, --message Commit message (defaults to 'Update')
|
}
|
||||||
|
|
||||||
Examples:
|
help() {
|
||||||
|
local cmd="$(basename $0)"
|
||||||
|
echo 'Usage:'
|
||||||
|
echo " $cmd <REPO> <SOURCE>"
|
||||||
|
echo ''
|
||||||
|
echo 'Parameters:'
|
||||||
|
echo " REPO repository to push to in 'user/repo' form"
|
||||||
|
echo " SOURCE path to upload to repository's gh-pages branch"
|
||||||
|
echo ''
|
||||||
|
echo 'Options:'
|
||||||
|
echo ' -h, --help show help screen'
|
||||||
|
echo ' -f, --force force push'
|
||||||
|
echo ' -n, --dry-run run in simulation mode'
|
||||||
|
echo ' -e, --use-env pick up arguments from environment variables'
|
||||||
|
echo ' -b, --branch use this branch name (default: gh-pages)'
|
||||||
|
echo ' -a, --author set the author'
|
||||||
|
echo ' -k, --keep keep existing files in the repo'
|
||||||
|
echo ''
|
||||||
|
echo 'Env var options:'
|
||||||
|
echo ' GITHUB_TOKEN if set, use this to push to the repo'
|
||||||
|
echo ''
|
||||||
|
echo 'Optional env vars:'
|
||||||
|
echo " Run with '-e' to enable the use of these variables."
|
||||||
|
echo " GIT_NAME set this as the repos user.name"
|
||||||
|
echo ' GIT_EMAIL set this as the repos user.email'
|
||||||
|
echo ' GITHUB_REPO substitute as the REPO (1st argument)'
|
||||||
|
echo ' GIT_SOURCE substitute as the SOURCE (2nd argument)'
|
||||||
|
echo ' GIT_BRANCH use this branch name (--branch)'
|
||||||
|
echo ''
|
||||||
|
echo 'Example:'
|
||||||
|
echo " $cmd rstacruz/myproject doc"
|
||||||
|
echo " # pushes './doc' into the gh-pages branch of rstacruz/myproject"
|
||||||
|
echo ''
|
||||||
|
echo " export GITHUB_REPO='xyz/abc'"
|
||||||
|
echo " export GIT_SOURCE='docs'"
|
||||||
|
echo " $cmd -e"
|
||||||
|
echo " # pushes './doc' into the gh-pages branch of xyz/abc"
|
||||||
|
}
|
||||||
|
|
||||||
Update the repo 'coffee' of github user 'james' with the files from the
|
#
|
||||||
current directory. The files will be in http://james.github.com/coffee.
|
# Defaults
|
||||||
|
#
|
||||||
|
|
||||||
$ git update-ghpages james/coffee
|
force=0
|
||||||
|
dryrun=0
|
||||||
|
repospec=
|
||||||
|
source=
|
||||||
|
branch=
|
||||||
|
message="Update"
|
||||||
|
useenv=0
|
||||||
|
author=""
|
||||||
|
keep=0
|
||||||
|
|
||||||
Same as above, but take the files from 'doc/'.
|
#
|
||||||
|
# Parse args
|
||||||
|
#
|
||||||
|
|
||||||
$ git update-ghpages james/coffee -i doc
|
while [[ "$1" =~ ^- && ! "$1" == '--' ]]; do case $1 in
|
||||||
|
-h | --help )
|
||||||
|
help
|
||||||
|
exit
|
||||||
|
;;
|
||||||
|
-b | --branch )
|
||||||
|
shift
|
||||||
|
branch="$1"
|
||||||
|
;;
|
||||||
|
-n | --dry-run )
|
||||||
|
dryrun=1
|
||||||
|
;;
|
||||||
|
-e | --use-env )
|
||||||
|
useenv=1
|
||||||
|
;;
|
||||||
|
-k | --keep )
|
||||||
|
keep=1
|
||||||
|
;;
|
||||||
|
-a | --author)
|
||||||
|
shift
|
||||||
|
author="$1"
|
||||||
|
;;
|
||||||
|
-f | --force )
|
||||||
|
force=1
|
||||||
|
;;
|
||||||
|
esac; shift; done
|
||||||
|
if [[ "$1" == '--' ]]; then shift; fi
|
||||||
|
|
||||||
Same as the first, but the files will instead be in
|
if [[ "$useenv" == "1" ]] && [[ -n "$GIT_BRANCH" ]] && [[ -z "$branch" ]]; then
|
||||||
http://james.github.com/coffee/manual.
|
branch="$GIT_BRANCH"
|
||||||
|
fi
|
||||||
|
|
||||||
$ git update-ghpages james/coffee -i doc -p manual
|
if [[ "$useenv" == "1" ]] && [[ -n "$GITHUB_REPO" ]] && [[ -n "$GIT_SOURCE" ]] && [[ -z "$2" ]]; then
|
||||||
}.gsub(/^ {4}/, '')
|
repospec="$GITHUB_REPO"
|
||||||
end
|
source="$GIT_SOURCE"
|
||||||
|
else
|
||||||
|
repospec="$1"
|
||||||
|
source="$2"
|
||||||
|
fi
|
||||||
|
|
||||||
private # Helpers
|
: ${branch:="gh-pages"}
|
||||||
|
|
||||||
def tip(msg)
|
if [ -z "$source" ]; then
|
||||||
$stderr.write "#{msg}\n"
|
help
|
||||||
end
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
def github_format?(str)
|
source="`pwd -LP`/$source"
|
||||||
str =~ /^([A-Za-z0-9\-_]+)\/([A-Za-z0-9\-_\.]+)$/
|
repo="https://github.com/${repospec}.git"
|
||||||
end
|
|
||||||
|
|
||||||
# Performs actions inside a temp path.
|
run
|
||||||
def in_temp_path(&blk)
|
|
||||||
require 'tmpdir'
|
|
||||||
Dir.mktmpdir do |dir|
|
|
||||||
Dir.chdir(dir) { yield dir }
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
def system!(str)
|
|
||||||
puts `#{str} 2>&1`.strip.gsub(/^/, " ")
|
|
||||||
raise "Failed with exit code #{$?.to_i}" unless $?.to_i == 0
|
|
||||||
end
|
|
||||||
|
|
||||||
# Returns the current branch name
|
|
||||||
def git_branch
|
|
||||||
`git symbolic-ref HEAD`.strip.split('/').last
|
|
||||||
end
|
|
||||||
|
|
||||||
# Copy files from source folder to another
|
|
||||||
def copy_files(from, to)
|
|
||||||
status "Copying files #{from} => #{to}..." if verbose?
|
|
||||||
|
|
||||||
Dir["#{from}/**/*"].each do |f|
|
|
||||||
next unless File.file?(f)
|
|
||||||
|
|
||||||
target = File.join(to, f.gsub(/^#{Regexp.escape from}/, ''))
|
|
||||||
|
|
||||||
FileUtils.mkdir_p File.dirname(target)
|
|
||||||
msg "%20s => %-20s" % [f, target] if verbose?
|
|
||||||
FileUtils.cp f, target
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
end
|
|
||||||
|
|
||||||
CLI.new.run!
|
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue