Skip to content

antifragilesoftware/scattered-rugs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 

Repository files navigation

scattered-rugs

Build Status Slack Status

This Rug project contains Playground for Rugs used when exploring the concepts in the Antifragile Software Book.

Rugs

AddLocalEditor

The AddLocalEditor editor adds an editor for modifying the local project, initiating a Rug archive if needed.

Prerequisites

A source code project.

Parameters

This Rug takes following parameters.

Name Required Default Description
editorName Yes Name of the editor to add, it should start with a capital letter and contain only alphanumeric characters
description No "an editor for modifying this project" A short description of what the editor will do

Running

Run this Rug as follows:

$ cd project/directory
$ rug edit antifragilesoftware:scattered-rugs:AddLocalEditor \
    editorName=MyLocalEditor \
    description='does something useful'

This will add a Rug editor as .atomist/editors/MyLocalEditor.ts. If the project is currently set up for Atomist, it will also create the .atomist directory with appropriate initial contents like the manifest.yml and package.json files and the Rug TypeScript typings in the node_modules directory.

BasicMavenProject

Generates a basic maven project.

Prerequisites

This Rug has no prerequisites.

Parameters

This Rug takes following parameters.

Name Required Default Description
projectName Yes Name of project to be created

Running

Run this Rug as follows:

$ cd parent/directory
$ rug generate atomist-rugs:rug-editors:BasicMavenProject \
    my-new-project

Explain what your generator does here.

Support

General support questions should be discussed in the #support channel on our community Slack team at atomist-community.slack.com.

If you find a problem, please create an issue.

Development

You can build, test, and install the project locally with the Rug CLI.

$ rug test
$ rug install

To create a new release of the project, simply push a tag of the form M.N.P where M, N, and P are integers that form the next appropriate semantic version for release. For example:

$ git tag -a 1.2.3

The Travis CI build (see badge at the top of this page) will automatically create a GitHub release using the tag name for the release and the comment provided on the annotated tag as the contents of the release notes. It will also automatically upload the needed artifacts.


Created by Atomist. Need Help? Join our Slack team.

About

Playground for Rugs used when exploring the concepts in the Antifragile Software Book.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published