@@ -6,7 +6,7 @@ == DESCRIPTION -Stickler is a tool to organize and maintain an internal gem distribution server. +Stickler is a tool to organize and maintain an internal gem distribution. At times it is useful to have complete control over the availability of the gems for you testing, staging and production environments. In these cases you @@ -14,29 +14,65 @@ probably do not want to accidentally type 'gem update' and get a new untested version of a gem installed on your machines. This is where Stickler helps. Configure stickler with the the names and versions of the gems you require for -your deployment and it will organize and setup a gem server to serve up only -those gems. +your deployment and it will organize and setup everything that is necessary for +a standard web server to function as your internal gem distribution server. == INSTALLATION Install as a gem: - sudo gem install stickler + gem install stickler Or Get it from RubyForge[http://rubyforge.org/projects/copiousfreetime/] or github[http://github.com/copiousfreetime/stickler/tree/master] -== FEATURES +== SYNOPSIS -* Serve up a custom collection of gems for your own use. -* Generation of a custom 'sources' gem to have your rubygems installations point - to your custom gem server. -* Tracking of the gems you care about and notification when a new version of those - are released on rubyforge. -* Integrates with your internal build system so your internal gems can be - deployed to the stickler gem server +Using stickler is fairly simple. First install it, then create a new stickler +repository with the setup command: -== SYNOPSIS + stickler setup /var/stickler + +This will create a stickler repository in /var/stickler, assuming you have the +correct permissions to create that directory. Now you need to populate it with +some gems. You can add and remove both gems and sources. The best way to do +this is to change into stickler repository and run other commands. + + cd /var/stickler + stickler add gem ramaze + +This will prompt you for the gem version requirement for 'ramaze' and then +download ramaze and everything it depends upon into the stickler repository. + +You can also add your own upstream gem repository to stickler. This enables you +to merge multiple upstream repositories into a single repository. + + stickler add source http://gems.example.com/ + +Now you can add gems to your stickler repository that are found in the default +upstream repository (rubygems) and your custom upstream repositories. It will +even resolve dependencies between them. + +When you are ready to distribute the gems found in your stickler repository, +edit the 'stickler.yml' file found in the root of your repository and set the +'downstream_source' configuration variable. This is the location that your +installed rubygems clients will contact to download gems. Most likely something +like 'http://gems.example.com' or whatever your company / organization name is. + +Then run the index command to generate the distributable gem repository. + + stickler generate index + +This generates a directory structure under the 'dist' directory that you can +rsync to a web server or otherwise push to some location for your managed +machines to contact for gems. + +If you want to setup a system gem source configuration, use the 'generate +sysconfig' command to generate the text file you can put on your systems so that +they contact the 'downstream_source' as the default gem server. The command +informs you of where to install the file. + + stickler generate sysconfig == CREDITS @@ -45,5 +81,6 @@ or github[http://github.com/copiousfreetime/stickler/tree/master] == LICENSE Copyright (c) 2008 Jeremy Hinegardner + All rights reserved. Licensed under the same terms as Ruby. No warranty is provided. See LICENSE and COPYING for details. README @@ -6,7 +6,7 @@ # The source that other rubygems installations will use to access the gems # collected and managed by stickler. -downstream_source: "http://gems.collectiveintellect.com/" +downstream_source: "http://gems.example.com/" # The upstream locations that stickler should look for gems. sources: data/stickler.yml @@ -14,8 +14,22 @@ Stickler::GEM_SPEC = Gem::Specification.new do |spec| spec.description = proj.description spec.platform = Gem::Platform::RUBY + spec.post_install_message = <<-msg + ============================================================ + + Thank you for installing Stickler! + + * Create a new stickler repository: + stickler setup /path/to/repo + + * Look at the help: + stickler help + + ============================================================ + msg + + spec.required_rubygems_version = [ ">= 1.2.0" ] - spec.post_install_message = "Run `stickler help` for more information" spec.add_runtime_dependency( 'highline', "~> 1.4" ) spec.add_runtime_dependency( 'logging', "~> 0.9" ) gemspec.rb @@ -42,11 +42,12 @@ module Stickler examples <<-txt . stickler setup - . stickler delete rails - . stickler add ramaze - . stickler add keybox --version 1.2.1 - . stickler check --email 'admin@example.com' - . stickler list + . stickler remove gem rails + . stickler add gem ramaze + . stickler add gem keybox --version 1.2.1 + . stickler sync + . stickler info + . stickler generate index txt option( :quiet, "q" ) { @@ -221,11 +222,12 @@ module Stickler desc example <<-txt - . sticker sync + . sticker sync --rebuild txt mixin :option_directory option( :rebuild ) { + description "Rebuild the repository from scratch" default false } lib/stickler/cli.rb fa687d19fb93bee26e732f1bee0d1007216b0559 Jeremy Hinegardner jeremy@hinegardner.org http://github.com/copiousfreetime/stickler/commit/c17151933bc4551635c84b22c8731d03cca86786 c17151933bc4551635c84b22c8731d03cca86786 2008-10-09T21:12:41-07:00 2008-10-09T21:12:41-07:00 documentation cleanup in preparation for first release 65d17a83d1cec358228c9d94f027dc76a6359890 Jeremy Hinegardner jeremy@hinegardner.org