{"id":13849958,"url":"https://github.com/atomist-attic/licensing-editors","last_synced_at":"2025-07-12T21:32:30.136Z","repository":{"id":141018832,"uuid":"75098149","full_name":"atomist-attic/licensing-editors","owner":"atomist-attic","description":"Editors to manage licenses and copyright notices","archived":true,"fork":false,"pushed_at":"2017-02-01T17:58:21.000Z","size":120,"stargazers_count":0,"open_issues_count":1,"forks_count":1,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-06-22T15:02:58.570Z","etag":null,"topics":["atomist","rug","typescript"],"latest_commit_sha":null,"homepage":null,"language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/atomist-attic.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-11-29T16:05:38.000Z","updated_at":"2023-01-28T18:57:52.000Z","dependencies_parsed_at":null,"dependency_job_id":"2c264145-d6e6-4311-a31f-d206a51b860d","html_url":"https://github.com/atomist-attic/licensing-editors","commit_stats":null,"previous_names":["atomist-rugs/licensing-editors"],"tags_count":22,"template":false,"template_full_name":null,"purl":"pkg:github/atomist-attic/licensing-editors","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/atomist-attic%2Flicensing-editors","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/atomist-attic%2Flicensing-editors/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/atomist-attic%2Flicensing-editors/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/atomist-attic%2Flicensing-editors/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/atomist-attic","download_url":"https://codeload.github.com/atomist-attic/licensing-editors/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/atomist-attic%2Flicensing-editors/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264910716,"owners_count":23682121,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["atomist","rug","typescript"],"created_at":"2024-08-04T20:00:53.949Z","updated_at":"2025-07-12T21:32:29.851Z","avatar_url":"https://github.com/atomist-attic.png","language":"Shell","funding_links":[],"categories":["Licencing"],"sub_categories":[],"readme":"# Atomist 'licensing-editors'\n\n[![Build Status](https://travis-ci.org/atomist-rugs/licensing-editors.svg?branch=master)](https://travis-ci.org/atomist-rugs/licensing-editors)\n[![Slack Status](https://join.atomist.com/badge.svg)](https://join.atomist.com)\n\nThis [Rug](http://docs.atomist.com/) archive has editors that manage\nlicense files and copyright notices in software projects.  License\nfiles come from http://choosealicense.com/ .\n\n## Rugs\n\n### AddLicenseFile\n\nThe AddLicenseFile editor adds a license file to a project.  If a\nlicense file already exists in the project, it replaces it.  If more\nthan one license file exists in the project, it refuses to do\nanything.\n\n#### Prerequisites\n\nBefore running this Editor, you must have the following prerequisites\nsatisfied.\n\n*   A project with zero or one license file\n\n#### Parameters\n\nTo run this editor, you must supply the following parameters.\n\n*   `license_name`: The name of the license to add to the project.\n    Available licenses can be found in the Atomist [templates][]\n    directory.  The value provided for the `license_name` parameter\n    should be the name of one of the files in that directory, without\n    the `.yml` extension.\n\n[templates]: https://github.com/atomist-rugs/licensing-editors/tree/master/.atomist/templates\n\n#### Running\n\nRun it as follows:\n\n```\n$ cd to/your/project\n$ rug edit atomist-rugs:licensing-editors:AddLicenseFile \\\n    license_name=mit\n```\n\nThis will add the MIT license to the project.  If no license file is\nfound in the project, the license will be put in a file named\n`LICENSE` at the root of the project.  If a file named `LICENSE`,\n`LICENSE.txt`, or `LICENSE.md` is found in the project (the search is\ncase insensitive), the contents of that file will be replaced with the\nprovided license.  If you like the changes, commit them.\n\n## Support\n\nGeneral support questions should be discussed in the `#support`\nchannel on our community slack team\nat [atomist-community.slack.com][slack].\n\nIf you find a problem, please create an [issue][].\n\n[issue]: https://github.com/atomist-rugs/licensing-editors/issues\n\n## Development\n\nYou can build, test, and install the project locally with\nthe [Rug CLI][cli].  Before running the Rug CLI and after any changes\nto the `.atomist/package.json` file, you should ensure all of the\ndependencies are available locally by running `npm install`.\n\n[cli]: https://github.com/atomist/rug-cli\n\n```sh\n$ cd .atomist\n$ npm install\n$ rug test\n$ rug install\n```\n\nTo create a new release of the project, simply push a tag of the form\n`M.N.P` where `M`, `N`, and `P` are integers that form the next\nappropriate [semantic version][semver] for release.  For example:\n\n```sh\n$ git tag -a 1.2.3\n```\n\nThe Travis CI build (see badge at the top of this page) will\nautomatically create a GitHub release using the tag name for the\nrelease and the comment provided on the annotated tag as the contents\nof the release notes.  It will also automatically upload the needed\nartifacts.\n\n---\nCreated by [Atomist][atomist].\nNeed Help?  [Join our Slack team][slack].\n\n[atomist]: https://www.atomist.com/\n[slack]: https://join.atomist.com/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fatomist-attic%2Flicensing-editors","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fatomist-attic%2Flicensing-editors","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fatomist-attic%2Flicensing-editors/lists"}