Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
svanherk authored Feb 23, 2024
1 parent 4377014 commit 1e760e9
Showing 1 changed file with 4 additions and 8 deletions.
12 changes: 4 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
[![Build Status](https://api.travis-ci.com/Brightspace/d2l-license-checker.svg?branch=master)](https://travis-ci.com/Brightspace/d2l-license-checker-ci)

# d2l-license-checker

A simple tool to check licenses of all npm dependencies in a project against an approved set of licenses. Can be added to a test suite / CI to get a warning about packages not meeting predefined license requirements. This is basically a wrapper around [`davglass/license-checker`](https://github.com/davglass/license-checker)
Expand Down Expand Up @@ -53,10 +51,8 @@ The configuration file is a simple JSON file with the following optional entries

* `"ignoreUnusedManualOverrides"`: Set it to true if you do not want warnings logged when you have unused manual overrides (`false` by default)

## Contributing
## Versioning and Releasing

This repo is configured to use `semantic-release`. Commits prefixed with `fix:` and `feat:` will trigger patch and minor releases when merged to `main`.

1. Update code.
1. Update version in `package.json`.
1. Commit/merge changes via pull request.
1. Run `Release new version` GitHub action workflow.
1. Travis will automatically publish tagged commits to npmjs.org.
To learn how to create major releases and release from maintenance branches, refer to the [semantic-release GitHub Action](https://github.com/BrightspaceUI/actions/tree/main/semantic-release) documentation.

0 comments on commit 1e760e9

Please sign in to comment.