From 9fc9c75d54a07564643d381b3efd454ae5cd2a31 Mon Sep 17 00:00:00 2001 From: localhostdotdev Date: Thu, 21 Mar 2019 03:20:57 +0100 Subject: [PATCH 1/2] Configurable path that defaults to the gitignored ./checkout/ directory Prevents polluting home directory on non-CI/prod servers --- .gitignore | 1 + bin/generate_docs.rb | 16 ++++++++++++++-- 2 files changed, 15 insertions(+), 2 deletions(-) diff --git a/.gitignore b/.gitignore index 46957c4..d66a6f3 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ Vagrantfile .vagrant +checkout/ diff --git a/bin/generate_docs.rb b/bin/generate_docs.rb index a4795eb..053df9e 100755 --- a/bin/generate_docs.rb +++ b/bin/generate_docs.rb @@ -5,11 +5,23 @@ require 'lock_file' require 'docs_generator' require 'git_manager' +require 'fileutils' + +if ARGV.size > 1 || ARGV.first == "-h" || ARGV.first == "--help" + puts "USAGE: bin/generate_docs.rb [CHECKOUT_PATH]" + exit +end + +CHECKOUT_PATH = ARGV.first || File.join(File.dirname(__FILE__), '../checkout') + +unless Dir.exists?(CHECKOUT_PATH) + FileUtils.mkdir(CHECKOUT_PATH) +end LockFile.acquiring('docs_generation.lock') do - git_manager = GitManager.new(Dir.home) + git_manager = GitManager.new(CHECKOUT_PATH) git_manager.update_master - generator = DocsGenerator.new(Dir.home, git_manager) + generator = DocsGenerator.new(CHECKOUT_PATH, git_manager) generator.generate end From 028fc5ed0a7522e713680e0e525feaadac730dc0 Mon Sep 17 00:00:00 2001 From: localhostdotdev Date: Thu, 21 Mar 2019 23:50:39 +0100 Subject: [PATCH 2/2] defaults to dir home for backward compatibility --- bin/generate_docs.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/bin/generate_docs.rb b/bin/generate_docs.rb index 053df9e..d3a37ce 100755 --- a/bin/generate_docs.rb +++ b/bin/generate_docs.rb @@ -12,7 +12,7 @@ exit end -CHECKOUT_PATH = ARGV.first || File.join(File.dirname(__FILE__), '../checkout') +CHECKOUT_PATH = ARGV.first || Dir.home unless Dir.exists?(CHECKOUT_PATH) FileUtils.mkdir(CHECKOUT_PATH)