diff --git a/CHANGELOG.md b/CHANGELOG.md index ccfc32b..cbe8eba 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,12 @@ # Changelog +## 2.0.0 (2017-11-08) + + * Add Node.js 8.x support + * Drop Node.js 0.10 and 0.12 support + * Tooling overhaul + ## 1.2.4 (2016-05-02) * Add Node.js 6.x support diff --git a/MIGRATION.md b/MIGRATION.md new file mode 100644 index 0000000..db49537 --- /dev/null +++ b/MIGRATION.md @@ -0,0 +1,16 @@ + +# Migration Guide + +The EachModule API changes between major versions. This is a guide to help you make the switch when this happens. + + +## Table Of Contents + + * [Migrating from 1.0 to 2.0](#migrating-from-10-to-20) + + +## Migrating from 1.0 to 2.0 + +### Node.js Support + +The only breaking change in EachModule 2.0 is that Node.js 0.10 and 0.12 are no longer supported. We'll be using newer ES6 features in upcoming releases which will not work in these older Node.js versions. diff --git a/README.md b/README.md index 06cab78..29d20d6 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,7 @@ eachModule('./examples', function (name, mod, file) { * [Requirements](#requirements) * [Usage](#usage) * [Contributing](#contributing) + * [Support and Migration](#support-and-migration) * [License](#license) @@ -72,6 +73,20 @@ make verify # run all linters ``` +## Support and Migration + +EachModule major versions are normally supported for 6 months after their last minor release. This means that patch-level changes will be added and bugs will be fixed. The table below outlines the end-of-support dates for major versions, and the last minor release for that version. + +We also maintain a [migration guide](MIGRATION.md) to help you migrate. + +| :grey_question: | Major Version | Last Minor Release | Node.js Versions | Support End Date | +| :-------------- | :-------------- | :----------------- | :--------------- | :--------------- | +| :heart: | 2 | N/A | 4+ | N/A | +| :hourglass: | [1][1.x-branch] | 1.2 | 0.10–6 | 2018-07-08 | + +If you're opening issues related to these, please mention the version that the issue relates to. + + ## License EachModule is licensed under the [MIT] license.
@@ -79,6 +94,7 @@ Copyright © 2014–2017, Rowan Manning +[1.x-branch]: https://github.com/rowanmanning/each-module/tree/1.x [mit]: LICENSE [node.js]: https://nodejs.org/ [npm]: https://www.npmjs.com/ diff --git a/package-lock.json b/package-lock.json index c07e239..57e655d 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "each-module", - "version": "1.2.4", + "version": "2.0.0", "lockfileVersion": 1, "requires": true, "dependencies": { diff --git a/package.json b/package.json index f31f2ad..0970a15 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "each-module", - "version": "1.2.5", + "version": "2.0.0", "description": "Execute a function on each module in a directory", "keywords": [ "each",