NEW
A flexible tool for releasing your code into the wild.
Quick Usage
gem install new
cd /my/project/dir
new init -n "My Project Name" -v "1.2.3"
new release
Global Newfile
You can set defaults in a Newfile in your home directory. These options will always be loaded whenever new runs. This is a great place to add your custom sources. You can use any format supported by Sourcerer
sources:
local: /path/to/local/new-tasks
remote: my-github-username/repo-with-new-tasks
Project Newfile
To use new, you need to have a Newfile in the root of the project. The Newfile is a YAML formatted file containing information about your project. A name
, version
, and at least 1 task
is required.
- Run
new init
from your project directory to create your Newfile *see Quick Usage above - Run
new tasks
to view all available tasks
Required options
-
name
: The name of your project -
version
: The current verison of your software -
tasks
: A list of tasks (and their options) to run in order
name: My Project Name
version: 1.2.3
tasks:
github:
username: brewster1134
gem:
gemspec:
author: Ryan Brewster
summary: Project summary
Release New Version
To release a new version of your software, simply run new release
from your project's root. You will be prompted to choose what new semantic version you want to release. Make sure to follow semantic versioning rules!
new release
Commands
Run new help
to view available commands
Development
Install Dependencies
gem install yuyi
yuyi -m https://raw.githubusercontent.com/brewster1134/new/master/Yuyifile
bundle install
To test the new gem...
bundle exec guard
To test tasks...
new test
- You can use the
-w
flag to watch local tasks and automatically run the tests when there are file changes. - You can specify a source, a task, or both to test with the following options.
Options:
-w, [--watch], [--no-watch] # Watch local tasks for changes and run tests
-s, [--source=SOURCE] # Source name
-t, [--task=TASK] name
# e.g. to watch a local `gem` task specified by a source named `local`
new tasks -w -s local -t gem