licensing-editors's Introduction

Atomist 'licensing-editors'

This Rug archive has editors that manage license files and copyright notices in software projects. License files come from http://choosealicense.com/ .

Rugs

AddLicenseFile

The AddLicenseFile editor adds a license file to a project. If a license file already exists in the project, it replaces it. If more than one license file exists in the project, it refuses to do anything.

Prerequisites

Before running this Editor, you must have the following prerequisites satisfied.

A project with zero or one license file

Parameters

To run this editor, you must supply the following parameters.

license_name: The name of the license to add to the project. Available licenses can be found in the Atomist templates directory. The value provided for the license_name parameter should be the name of one of the files in that directory, without the .yml extension.

Running

Run it as follows:

$ cd to/your/project
$ rug edit atomist-rugs:licensing-editors:AddLicenseFile \
    license_name=mit

This will add the MIT license to the project. If no license file is found in the project, the license will be put in a file named LICENSE at the root of the project. If a file named LICENSE, LICENSE.txt, or LICENSE.md is found in the project (the search is case insensitive), the contents of that file will be replaced with the provided license. If you like the changes, commit them.

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. Before running the Rug CLI and after any changes to the .atomist/package.json file, you should ensure all of the dependencies are available locally by running npm install.

$ cd .atomist
$ npm install
$ 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][semver] 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.

licensing-editors's People

Watchers

licensing-editors's Issues

Create AddLicenseFile editor using TS

Add support for setting copyright notices in source files

Licenses containg `---` are cut-off

Running:
rug edit atomist-rugs:licensing-editors:AddLicenseFile license_name=mpl-2.0

Generates bad LICENSE file:



Mozilla Public License Version 2.0
==================================

1. Definitions

(this is content of whole LICENSE file).

Problem is that license text is cut-off thanks to YAML multi-document feature.
YAML is splitting .yml files to multiple documents using ---.
In .atomist/templates/mpl-2.0.yml there is: