Command line options

From RubyPackager

Jump to: navigation, search

Contents

[edit] Description

Release.rb
  [-h|--help]
  [-e|--debug]
  [-v|--version <Version>]
  [-t|--tag <TagName>]*
  [-c|--comment <Comment>]
  [-r|--ruby]
  [-n|--includeTest]
  [-o|--no-rdoc]
  [-i|--installer <InstallerName>]*
  [-d|--distributor <DistributorName>]*
  <ReleaseFile>

[edit] -h, --help

  • Display help usage.
  • Optional

[edit] -e, --debug

  • Activate debugging logs.
  • Optional

[edit] -v, --version <Version>

  • Set the version of the deliverables to release
  • <Version>: Version string of the release (ex. 0.0.1)
  • Optional

[edit] -t, --tag <TagName>

  • Set a Tag to this version.
  • <TagName>: Tag to apply to this version (ex. WindowsOnly).
  • A Tag is a way to categorize the version.
  • Optional
  • Can be specified multiple times

[edit] -c, --comment <Comment>

  • Set the release comment to display for this release.
  • <Comment>: Comment to add to the release note (ex. First release. To be used with caution.)
  • Optional

[edit] -r, --ruby

  • Include Ruby distribution in the executable release.
  • This is used to make sure that the delivered executable will also run on platforms that don't have Ruby installed.
  • Optional
  • Only for executable releases

[edit] -n, --includeTest

  • Include Test files in the release.
  • Optional

[edit] -o, --no-rdoc

  • Prevents from generating RDoc.
  • Optional

[edit] -i, --installer <InstallerName>

  • Generate the deliverables corresponding to the given installer.
  • <InstallerName>: Name of an Installer to use (ex. Gem).
  • Installers are used to package the library/binary.
  • Installers are searched among plugins shipped with RubyPackager (directory lib/RubyPackager/Installers). They can be added and removed anytime.
  • Current available Installers are:
    • NSIS
    • Gem
  • Optional
  • Can be specified multiple times

[edit] -d, --distributor <DistributorName>

  • <DistributorName>: Name of a Distributor to use.
  • Ship generated installers to a distributor.
  • Distributors are used to upload the generated deliverables to specific providers.
  • Distributors are searched among plugins shipped with RubyPackager (directory lib/RubyPackager/Distributors). They can be added and removed anytime.
  • Current available Distributors are:
    • RubyGems
    • SourceForge
  • Optional
  • Can be specified multiple times

[edit] <ReleaseFile>

  • Name of the release file describing the project to release (ex. MyProjectInfo.rb).
  • You can check Release file API to know how to write a release file.
  • Mandatory

[edit] Examples

[edit] Release a simple version

Release -v 0.1 MyReleaseInfo.rb

[edit] Release a version that will be installable using RubyGems

Release -v 0.1 -i Gem MyReleaseInfo.rb

[edit] Release a version that will be installable using RubyGems, and upload it on SourceForge

Release -v 0.1 -i Gem -d SourceForge MyReleaseInfo.rb

[edit] Release a version with a comment and generate both an executable installer for Windows and a Gem

Release -v 0.1 -c "My first release" -i NSIS -i Gem MyReleaseInfo.rb

[edit] Release a version of an installable executable with Ruby embedded

Release -v 0.1 -r -i NSIS MyReleaseInfo.rb
Personal tools