docs: update README & changelog

mjeanroy · Apr 18, 2024 · bdfca87 · bdfca87
1 parent 2c51c64
commit bdfca87
Show file tree

Hide file tree

Showing 2 changed files with 58 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,41 @@
+## 3.4.0 (2024-04-18)
+
+* release: prepare next release ([1c6c911](https://github.com/mjeanroy/rollup-plugin-license/commit/1c6c911))
+* release: release version ([a576572](https://github.com/mjeanroy/rollup-plugin-license/commit/a576572))
+* chore: add changelog update workflow ([5f4ed57](https://github.com/mjeanroy/rollup-plugin-license/commit/5f4ed57))
+* chore: update changelog ([a48e164](https://github.com/mjeanroy/rollup-plugin-license/commit/a48e164))
+* chore: update readme ([8254eae](https://github.com/mjeanroy/rollup-plugin-license/commit/8254eae))
+* chore(ci): add node 21 ([80cefa0](https://github.com/mjeanroy/rollup-plugin-license/commit/80cefa0))
+* chore(ci): remove invalid option ([16e4d5d](https://github.com/mjeanroy/rollup-plugin-license/commit/16e4d5d))
+* chore(ci): update actions/checkout to version 4.1.2 ([9742e59](https://github.com/mjeanroy/rollup-plugin-license/commit/9742e59))
+* chore(ci): use node 20 ([184cc0b](https://github.com/mjeanroy/rollup-plugin-license/commit/184cc0b))
+* chore(deps-dev): bump gulp from 4.0.2 to 5.0.0 (#1702) ([f9d39d5](https://github.com/mjeanroy/rollup-plugin-license/commit/f9d39d5)), closes [#1702](https://github.com/mjeanroy/rollup-plugin-license/issues/1702)
+* chore(deps-dev): bump rollup from 4.12.1 to 4.13.0 (#1692) ([51ceaf8](https://github.com/mjeanroy/rollup-plugin-license/commit/51ceaf8)), closes [#1692](https://github.com/mjeanroy/rollup-plugin-license/issues/1692)
+* chore(deps-dev): bump rollup from 4.13.0 to 4.13.2 (#1700) ([f2d3210](https://github.com/mjeanroy/rollup-plugin-license/commit/f2d3210)), closes [#1700](https://github.com/mjeanroy/rollup-plugin-license/issues/1700)
+* chore(deps-dev): bump rollup from 4.13.2 to 4.14.0 (#1705) ([72fa64b](https://github.com/mjeanroy/rollup-plugin-license/commit/72fa64b)), closes [#1705](https://github.com/mjeanroy/rollup-plugin-license/issues/1705)
+* chore(deps-dev): bump rollup from 4.14.0 to 4.14.1 (#1708) ([7226c85](https://github.com/mjeanroy/rollup-plugin-license/commit/7226c85)), closes [#1708](https://github.com/mjeanroy/rollup-plugin-license/issues/1708)
+* chore(deps-dev): bump rollup from 4.14.1 to 4.14.2 (#1710) ([15f1b92](https://github.com/mjeanroy/rollup-plugin-license/commit/15f1b92)), closes [#1710](https://github.com/mjeanroy/rollup-plugin-license/issues/1710)
+* chore(deps-dev): bump rollup from 4.14.2 to 4.14.3 (#1712) ([dbd15b5](https://github.com/mjeanroy/rollup-plugin-license/commit/dbd15b5)), closes [#1712](https://github.com/mjeanroy/rollup-plugin-license/issues/1712)
+* chore(deps-dev): bump the babel group with 2 updates (#1695) ([8f07c26](https://github.com/mjeanroy/rollup-plugin-license/commit/8f07c26)), closes [#1695](https://github.com/mjeanroy/rollup-plugin-license/issues/1695)
+* chore(deps-dev): bump the babel group with 2 updates (#1696) ([2288801](https://github.com/mjeanroy/rollup-plugin-license/commit/2288801)), closes [#1696](https://github.com/mjeanroy/rollup-plugin-license/issues/1696)
+* chore(deps-dev): bump the babel group with 2 updates (#1704) ([94c9ba3](https://github.com/mjeanroy/rollup-plugin-license/commit/94c9ba3)), closes [#1704](https://github.com/mjeanroy/rollup-plugin-license/issues/1704)
+* chore(deps-dev): bump the typescript-eslint group with 2 updates (#1691) ([16d4524](https://github.com/mjeanroy/rollup-plugin-license/commit/16d4524)), closes [#1691](https://github.com/mjeanroy/rollup-plugin-license/issues/1691)
+* chore(deps-dev): bump the typescript-eslint group with 2 updates (#1693) ([037c525](https://github.com/mjeanroy/rollup-plugin-license/commit/037c525)), closes [#1693](https://github.com/mjeanroy/rollup-plugin-license/issues/1693)
+* chore(deps-dev): bump the typescript-eslint group with 2 updates (#1694) ([8ef73df](https://github.com/mjeanroy/rollup-plugin-license/commit/8ef73df)), closes [#1694](https://github.com/mjeanroy/rollup-plugin-license/issues/1694)
+* chore(deps-dev): bump the typescript-eslint group with 2 updates (#1698) ([256733e](https://github.com/mjeanroy/rollup-plugin-license/commit/256733e)), closes [#1698](https://github.com/mjeanroy/rollup-plugin-license/issues/1698)
+* chore(deps-dev): bump the typescript-eslint group with 2 updates (#1703) ([31394bc](https://github.com/mjeanroy/rollup-plugin-license/commit/31394bc)), closes [#1703](https://github.com/mjeanroy/rollup-plugin-license/issues/1703)
+* chore(deps-dev): bump the typescript-eslint group with 2 updates (#1707) ([90d1a1f](https://github.com/mjeanroy/rollup-plugin-license/commit/90d1a1f)), closes [#1707](https://github.com/mjeanroy/rollup-plugin-license/issues/1707)
+* chore(deps-dev): bump the typescript-eslint group with 2 updates (#1711) ([60af719](https://github.com/mjeanroy/rollup-plugin-license/commit/60af719)), closes [#1711](https://github.com/mjeanroy/rollup-plugin-license/issues/1711)
+* chore(deps-dev): bump typescript from 5.4.2 to 5.4.3 (#1697) ([262e020](https://github.com/mjeanroy/rollup-plugin-license/commit/262e020)), closes [#1697](https://github.com/mjeanroy/rollup-plugin-license/issues/1697)
+* chore(deps-dev): bump typescript from 5.4.3 to 5.4.4 (#1706) ([44f4291](https://github.com/mjeanroy/rollup-plugin-license/commit/44f4291)), closes [#1706](https://github.com/mjeanroy/rollup-plugin-license/issues/1706)
+* chore(deps-dev): bump typescript from 5.4.4 to 5.4.5 (#1709) ([2cc74c9](https://github.com/mjeanroy/rollup-plugin-license/commit/2cc74c9)), closes [#1709](https://github.com/mjeanroy/rollup-plugin-license/issues/1709)
+* feat: optionally include self dependency ([66a2963](https://github.com/mjeanroy/rollup-plugin-license/commit/66a2963))
+* refactor: use map instead of object for internal cache ([6f50da5](https://github.com/mjeanroy/rollup-plugin-license/commit/6f50da5))
+* refactor: use map instead of object for internal dependencies store ([4d1282c](https://github.com/mjeanroy/rollup-plugin-license/commit/4d1282c))
+* refactor: use set instead of array ([d7db768](https://github.com/mjeanroy/rollup-plugin-license/commit/d7db768))
+
+
+
 ## <small>3.3.1 (2024-03-10)</small>
 
 * release: prepare next release ([eb46211](https://github.com/mjeanroy/rollup-plugin-license/commit/eb46211))

diff --git a/README.md b/README.md
@@ -44,6 +44,7 @@ module.exports = {
 
       thirdParty: {
         includePrivate: true, // Default is false.
+        includeSelf: true, // Default is false.
         multipleVersions: true, // Default is false.
         output: {
           file: path.join(__dirname, 'dist', 'dependencies.txt'),
@@ -265,6 +266,22 @@ license({
 })
 ```
 
+By default, the "self" package is ignored (by "self", we mean the package being built), but startint with version 3.4.0, you can force inclusion using the `includeSelf` option:
+
+```javascript
+license({
+  thirdParty: {
+    includeSelf: true,
+    output: {
+      file: path.join(__dirname, 'dist', 'dependencies.json'),
+      template(dependencies) {
+        return JSON.stringify(dependencies);
+      }
+    },
+  },
+})
+```
+
 ## License Checks
 
 Starting with version 0.13, it is possible to ensure that dependencies does not violate any license restriction.
@@ -331,6 +348,9 @@ license({
 
 ## Changelogs
 
+- 3.4.0
+  - Allow adding the license for the package itself into the thirdParty output [#1685](https://github.com/mjeanroy/rollup-plugin-license/issues/1685)
+  - Dependency upgrades
 - 3.3.1
   - Ensure the `multipleVersions` option is correctly validated ([#1682](https://github.com/mjeanroy/rollup-plugin-license/issues/1682))
 - 3.3.0