[DRE-commits] [librarian-puppet] 62/97: Issue #117 Default tmp dir to ./.tmp as it was before applying 80b2ea9

[Stig Sandbeck Mathisen]

This is an automated email from the git hooks/post-receive script.

ssm pushed a commit to branch master
in repository librarian-puppet.

commit db89275728874e7fcb6f954f1d61367cde8b96e9
Author: Carlos Sanchez <csanchez at maestrodev.com>
Date:   Thu Jan 9 15:26:32 2014 +0100

    Issue #117 Default tmp dir to ./.tmp as it was before applying 80b2ea9
    
    Librarian uses ./tmp by default
    Add Configuration section to the README from librarian-chef
---
 README.md                           | 66 +++++++++++++++++++++++++++++++++++++
 lib/librarian/puppet/environment.rb |  5 +++
 2 files changed, 71 insertions(+)

diff --git a/README.md b/README.md
index a429086..b9cab18 100644
--- a/README.md
+++ b/README.md
@@ -162,6 +162,72 @@ Update the version of a dependency:
     $ git add Puppetfile.lock
     $ git commit -m "bumped the version of apt up to 0.0.4."
 
+## Configuration
+
+Configuration comes from three sources with the following highest-to-lowest
+precedence:
+
+* The local config (`./.librarian/puppet/config`)
+* The environment
+* The global config (`~/.librarian/puppet/config`)
+
+You can inspect the final configuration with:
+
+    $ librarian-puppet config
+
+You can find out where a particular key is set with:
+
+    $ librarian-puppet config KEY
+
+You can set a key at the global level with:
+
+    $ librarian-puppet config KEY VALUE --global
+
+And remove it with:
+
+    $ librarian-puppet config KEY --global --delete
+
+You can set a key at the local level with:
+
+    $ librarian-puppet config KEY VALUE --local
+
+And remove it with:
+
+    $ librarian-puppet config KEY --local --delete
+
+You cannot set or delete environment-level config keys with the CLI.
+
+Configuration set at either the global or local level will affect subsequent
+invocations of `librarian-puppet`. Configurations set at the environment level are
+not saved and will not affect subsequent invocations of `librarian-puppet`.
+
+You can pass a config at the environment level by taking the original config key
+and transforming it: replace hyphens (`-`) with underscores (`_`) and periods
+(`.`) with doubled underscores (`__`), uppercase, and finally prefix with
+`LIBRARIAN_PUPPET_`. For example, to pass a config in the environment for the key
+`part-one.part-two`, set the environment variable
+`LIBRARIAN_PUPPET_PART_ONE__PART_TWO`.
+
+Configuration affects how various commands operate.
+
+* The `path` config sets the cookbooks directory to install to. If a relative
+  path, it is relative to the directory containing the `Puppetfile`. The
+  equivalent environment variable is `LIBRARIAN_PUPPET_PATH`.
+
+* The `tmp` config sets the cache directory for librarian. If a relative
+  path, it is relative to the directory containing the `Puppetfile`. The
+  equivalent environment variable is `LIBRARIAN_PUPPET_TMP`.
+
+Configuration can be set by passing specific options to other commands.
+
+* The `path` config can be set at the local level by passing the `--path` option
+  to the `install` command. It can be unset at the local level by passing the
+  `--no-path` option to the `install` command. Note that if this is set at the
+  environment or global level then, even if `--no-path` is given as an option,
+  the environment or global config will be used.
+
+
+
 ## How to Contribute
 
  * Pull requests please.
diff --git a/lib/librarian/puppet/environment.rb b/lib/librarian/puppet/environment.rb
index e457033..64ec342 100644
--- a/lib/librarian/puppet/environment.rb
+++ b/lib/librarian/puppet/environment.rb
@@ -11,6 +11,11 @@ module Librarian
         "puppet"
       end
 
+      def tmp_path
+        part = config_db["tmp"] || ".tmp"
+        project_path.join(part)
+      end
+
       def install_path
         part = config_db["path"] || "modules"
         project_path.join(part)

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-ruby-extras/librarian-puppet.git