This Rug project contains rugs used in the Atomist end-user documentation.
Rugs are typically run using the Atomist Bot in Slack. To run Rugs locally, you must first install the following tools:
Once those tools are installed, you can clone this repository and install its dependencies with the following command.
$ ( cd .atomist && yarn )
The AddLicense editor adds a LICENSE file to a project and license header comments to TypeScript files in a project.
A source code project.
This Rug takes following parameters.
| Name | Required | Default | Description |
|---|---|---|---|
include |
No | "" | Comma-separated list of paths under which to search for files, search under all paths if empty |
license |
No | "aslv2" | License to add, currently only "aslv2" is supported |
Run this Rug as follows:
$ cd project/directory
$ rug edit atomist:rug-rugs:AddLicense \
include=src,test \
license=aslv2
This will add the ASLv2 license as LICENSE to the file and add a
license header comment to all TypeScript files under the src and
test directories in the project.
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.
If you are interested in contributing to the Atomist open source projects, please see our contributing guidelines and our code of conduct.
You can build, test, and install the project locally with the Rug CLI and Yarn.
$ ( cd .atomist && yarn test )
$ rug install
To clean up cached files and update TypeScript dependencies, run this command.
$ ( cd .atomist && find editors generators handlers tests -name '*.js' -print0 | xargs -0 rm; rm -rf node_modules; yarn && rug clean )
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.