Skip to content

Latest commit

 

History

History
709 lines (309 loc) · 26.6 KB

CHANGES.md

File metadata and controls

709 lines (309 loc) · 26.6 KB

Changelog

3.6.1 (2024-08-14)

Bug Fixes

  • Webpack style loader. (ecec3cf)

    Webpack style loader's insert option needs a different way to reference functions. Also deprecate webpack-helpers module.

3.6.0 (2024-08-14)

Features

  • Add husky commitlint also to this package. (1bdcf63)

  • Add WebP as asset/resource along to the other formats for the Webpack loader. (58f369c)

Bug Fixes

  • Do not upgrade husky and keep at pre 9.x. (fe89852)

    Husky has some breaking changes which we should only upgrade with the next major release of @patternslib/dev.

  • Require minimum node v18.18. (807147a)

    This is Webpack's minimum required version. Note: As time of this commit, versions below 18 are unmaintained.

Maintenance

  • Remove plugin-transform-optional-chaining from babel. (9facee8)

    The optional chaining feature is already included in preset-env ES2020.

  • Upgrade dependencies. (c3d64fd)

    Upgrade all except eslint, which needs to migrate from .eslintrc.js to eslint.config.js. This will be done in an upcoming major release.

  • Upgrade GitHub Actions node version. (4c96faa)

  • Upgrade GitHub Actions. (f687bee)

3.5.3 (2023-11-22)

Maintenance

3.5.2 (2023-10-16)

Maintenance

3.5.1 (2023-09-23)

Maintenance

3.5.0 (2023-08-30)

Features

  • Tests: Add helper for conditional test skipping and node version parsing. (611b77b)

Maintenance

3.4.1 (2023-08-11)

Bug Fixes

  • Correct comment in Makefile. (5fb33c6)

Maintenance

3.4.0 (2023-07-27)

Maintenance

  • Depend on the minimum actively maintained Node.js version >= 16. (603a024)

  • Upgrade dependencies. (b3bb92f)

3.3.5 (2023-05-29)

Bug Fixes

  • Fix hook config from 3.3.4. (b4f02f6)

3.3.4 (2023-05-29)

Bug Fixes

  • Include the correct bundle version in entry file header comment. (ea32b4d)

    In order to have the correct version specifier in the bundle's entry script header comment the bundle must be built after the version bump. Use release-it hooks to do that.

Maintenance

3.3.3 (2023-05-28)

Bug Fixes

  • Add pre-built bundles to the npm distribution again. (c85dbdc)

    This was lost in a previous Makefile update. Now you can again reference jsdelivr and and unpkg to include bundles.

  • Change optional chaining babel plugin name. (e57793a)

Maintenance

  • Remove dependency on semver which is not needed since the recent Makefile improvements. (1dd1c3a)

  • Upgrade dependencies. (6d052b7)

3.3.2 (2023-05-11)

Maintenance

3.3.1 (2023-04-21)

Maintenance

3.3.0 (2023-04-17)

Bug Fixes

  • Simplify release make commands. (49077d2)

    Change the prerelease commands back to pre-3.2.0 names. This was necessary because the previous change did create for each command a new increment, which was not what we wanted. Instead the Makefile is now restructured:

  • First the npm release is done and the package.json written with the correct version. If no increment is given (in case of the prerelease targets) an interactive prompt asks the user to define one.
  • Second the GitHub release is done. It's no more necessary to guess the next version before the npm version was done. Instead we now rely on release-it choosing it for us. Now we do have again the "prerelease-alpha" and "prerelease-beta" Makefile targets.

3.2.0 (2023-04-17)

Features

  • Change prerelease commands to prerelease-INCREMENT-PREID (6b488e1)

    Change the prerelease commands to define the increment level. Instead of "prerelease-alpha" there are now "prerelease-major-alpha", "prerelease-minor-alpha" and "prerelease-patch-alpha". Instead of "prerelease-beta" there are now "prerelease-major-beta", "prerelease-minor-beta" and "prerelease-patch-beta". This fixes a problem where the first prerelease for major or minor increments got only a patch-level increment.

Maintenance

3.2.0 (2023-04-17)

Features

  • Change prerelease commands to prerelease-INCREMENT-PREID (6b488e1)

    Change the prerelease commands to define the increment level. Instead of "prerelease-alpha" there are now "prerelease-major-alpha", "prerelease-minor-alpha" and "prerelease-patch-alpha". Instead of "prerelease-beta" there are now "prerelease-major-beta", "prerelease-minor-beta" and "prerelease-patch-beta". This fixes a problem where the first prerelease for major or minor increments got only a patch-level increment.

Maintenance

3.1.13 (2023-04-17)

Bug Fixes

  • Improve the release-it commit template to include a newline between each commit and add any commit references to the end. (1603d0b)

  • Improve the release-it commit template to include a newline between header and body text. (14ace2b)

  • Include all changes since last regular release only in GitHub releases. (ec86755)

    When doing regular releases include all the changes since the last regular release - including changes from pre-releases in the release notes on GitHub, but not in the CHANGES.md file. In the CHANGES.md file every change can be seen at once. Including all the changes since the previous regular release is useful for the GitHub release page only.

Maintenance

3.1.13 (2023-04-17)

Bug Fixes

  • Improve the release-it commit template to include a newline between each commit and add any commit references to the end. (1603d0b)

  • Improve the release-it commit template to include a newline between header and body text. (14ace2b)

  • Include all changes since last regular release only in GitHub releases. (ec86755)

    When doing regular releases include all the changes since the last regular release - including changes from pre-releases in the release notes on GitHub, but not in the CHANGES.md file. In the CHANGES.md file every change can be seen at once. Including all the changes since the previous regular release is useful for the GitHub release page only.

Maintenance

3.1.12 (2023-04-03)

Maintenance

3.1.11 (2023-03-09)

Maintenance

3.1.10 (2023-02-14)

Maintenance

  • Upgrade dependencies. (4aad9c8)

  • When doing a final release, set tagExclude to ignore pre-releases when finding the last release. This should include all changelog entrief from the pre-releases. (4abf750)

3.1.9 (2023-01-25)

Maintenance

  • enable source maps for development again. (fdf8a86)

  • Upgrade dependencies. (feb26ce)

3.1.9 (2023-01-25)

Maintenance

  • enable source maps for development again. (fdf8a86)

  • Upgrade dependencies. (feb26ce)

3.1.8 (2022-12-19)

Maintenance

  • For non-minified development builds, do not generate source maps. (babf289)

  • Upgrade dependencies. (20f7b31)

3.1.8 (2022-12-19)

Maintenance

  • For non-minified development builds, do not generate source maps. (babf289)

  • Upgrade dependencies. (20f7b31)

3.1.7 (2022-12-11)

Maintenance

3.1.7 (2022-12-11)

Maintenance

3.1.6 (2022-12-07)

Maintenance

3.1.5 (2022-11-18)

Bug Fixes

  • Build: Get the correct version increment for prereleases. (8947884)

3.1.4 (2022-11-18)

Bug Fixes

3.1.3 (2022-11-18)

Bug Fixes

  • Webpack: Add the version banner only to the entry point files. (6f82df1)This fixes a problem where each chunk file was changed with a new release, even if nothing else than the version has changed. Adding the version banner only to the entry points still allows to check the version while keeping the changeset for releases small.

Maintenance

3.1.2 (2022-11-15)

Bug Fixes

  • Fix Makefile to not emit an error when no compiled bundle is found. (15363a7)

3.1.1 (2022-11-15)

Bug Fixes

  • Fix Makefile error with GitHub release. (7df20db)

3.1.0 (2022-11-15)

Features

  • Allow to add the compiled bundles to npm packages. (84bdefd)Creating a npm release with the Makefile prepares now a bundle build with the correct package version added as a comment to the bundle files. The compiled bundle can then be uploaded to npm if it is part of the git repository (included by .gitignore) or part of the npm release (preferred, included by .npmignore).

Adding the compiled bundle to npm allows to directly include it via a CDN like so:

https://cdn.jsdelivr.net/npm/@patternslib/[email protected]/dist/bundle.min.js or https://unpkg.com/@patternslib/[email protected]/dist/bundle.min.js

We have to compile the bundle with the correct version BEFORE the npm package is created with release-it. The next version is queried using the LEVEL parameter (set by the different release targets) and the "semver" tool.

Maintenance

3.0.0 (2022-10-15)

Features

  • Build: Add Module Federation configuration for webpack. (b84c2fb)

Breaking Changes

  • Build: Remove the showdown-prettify loading config and the now unused imports-loader. (27ba90f)

  • Tests: Remove dependency on jQuery. (259d801)Use the following in your test setup to provide jQuery to external libraries if they depend on a global jQuery object or extend from the jest config from @patternslib/patternslib:

import jquery from "jquery";
global.$ = global.jQuery = jquery;
  • Tests: Remove the Dependency on @patternslib/patternslib. (afe8fee)If you need Patternslib specific test setup, extend from Patternslib.

Maintenance

2.7.2 (2022-09-28)

Maintenance

2.7.1 (2022-09-20)

Maintenance

2.7.0 (2022-09-15)

Features

  • Define the close, show and showModal methods in dialog elements. (3b59aed)

Maintenance

2.6.0 (2022-09-05)

Bug Fixes

  • Fix GitHub Actions branch name. (e59126a)

Maintenance

2.5.0 (2022-08-19)

Features

  • Makefile: Add empty bundle-pre target for customization. (0290e61)The empty bundle-pre target is run before the bundle target and can be overwritten in extending projects to add some tasks before bundle generation. This can be used to unlink and reinstall any dependencies before bundle generation.

Maintenance

2.4.0 (2022-08-11)

Features

  • Webpack: Add bundle name and version to the banner. (1058b6d)For this, you have to pass your project's package.json as argument to the webpack config factory. Both values - name and version - are taken from the package.json data.

  • Webpack: Add config export with named parameters. (f7b2471)Add config export along with the default export to support named parameters via parameter destructuring.

Maintenance

  • Upgrade dependencies. (9039642)

  • Webpack: Correct API doc for shared_from_dependencies. (f2b0031)

2.3.0 (2022-07-07)

Features

  • Module Federation: Add a shared parameter for MF config factory. (22e4b5e)The shared parameter allows to directly provide the shared object for the Webpack Module Federation Plugin. It extends generated shared definitions from the dependencies object and will overwrite existing entries.

2.2.1 (2022-07-06)

Maintenance

2.2.0 (2022-06-27)

Bug Fixes

  • Fix missing parentheses in release-zip. (72d435d)

Breaking Changes

  • webpack module federation: Make wepack module federation config factory more explicit. (efd266c)Change signature of the webpack mf config factory to make it simpler, more flexible and more explicit at the cost of having to pass more options.
  • Remove parameters package_json and shared in favor of dependencies.
  • Explicitly pass all dependencies via dependencies, also the base ones from @patternslib/patternslib if wanted.
  • Always explicitly pass the module federation name (e.g. the package.json's package name).

This makes the MF config factory simpler although you probably have to pass more options. You now can easily just add the dependencies you want instead of having always @patternslib/patternslib dependencies added.

Maintenance

  • Add @plone to jest and webpack transform ignores. (678bf09)

  • Remove unnecessary import from webpack.config.js. (6658497)

  • Upgrade dependencies. (e1e423e)

2.1.0 (2022-06-25)

Features

  • Do not build a bundle and a release-zip for @patternslib/dev. (085a019)Still, we have the Makefile targets bundle and release-zip defined in the Makefile, making it possible to let other packages include this Makefile and extend from it while it is fully functioning for @patternslib/dev too.

Maintenance

  • Add jquery and @patternslib/patternslib to devDependencies, so that setup_tests.js does not fail when testing this package. (edae3f7)

  • Also remove eventual @plone/ from bundle name. (7696d7d)

  • Ignore .git directory when watching for changes. (14ff7e9)

  • Make @patternslib/patternslib a peer dependency which must be installed if e.g. the webpack.mf.js Webpack config is used. (987b421)

  • Upgrade dependencies. (7fac8d7)

  • Upgrade dependencies. (c632f09)

2.0.0 (2022-06-15)

Maintenance

  • Add test script to package.json. (55e8a8b)

  • Allow releases from master and from main branches. (f4f9528)

  • Configure commitlint for extendability. (6488bba)

  • Configure dependencies. (4db723d)Use dependencies field in package.json to install all development dependencies. This way, when another package depends on it via devDependencies, all dependencies will be installed.

  • Configure jest for extendability. (f4eeb3c)

  • Configure prettier for extendability. (0f27162)

  • Configure release-it for extendability. (4aedd68)

  • Configure webpack for extendability. (f805856)

  • Initial dev setup, based on @patternslib/patternslib. (12968fb)

  • Upgrade dependencies. (134295d)