@sendcloud/checkout-plugin-ui

A package for rendering custom shipping options in a shop system during the checkout process (e.g. delivery date picker for nominated day delivery).

Usage no npm install needed!

<script type="module">
  import sendcloudCheckoutPluginUi from 'https://cdn.skypack.dev/@sendcloud/checkout-plugin-ui';
</script>

README

Checkout plugin UI

A package for rendering custom shipping options in a shop system during the checkout process (e.g. delivery date picker for nominated day delivery).

Development

Installing dependencies

npm install

Starting a local development server

npm start

Running tests

npm test

Releasing a new package version

New versions of this package are published via semantic-release. Conventional commits are used to determine whether to release a new version and what version number to use. A regular release mechanism is triggered for merges into the project’s master branch. A pre-release mechanism is triggered when merging into a certain pre-release branch (e.g. beta, alpha, etc.).

A major version of the package will be released for commits with commit bodies including the phrase “BREAKING CHANGE” regardless of the commits’ type. A minor version of the package will be released for feat commits; a patch version for fix commits.

Releasing a new major package version

For breaking changes, a major package version must be released. Since the shop system plugins that use this package refer to it using minor version ranges (e.g. @1 or @^1.0.0), their implementation needs to be updated after a major version release. Also, the “cache:purge” job in the .gitlab-ci.yml file needs to be updated accordingly.

Verify browserslist configuration

Open the babel.config.js file and copy the value of the targets configuration and run npx browserslist $targets like this:

npx browserslist '> 1% in my stats and not ie <= 11'

This will result in an output like this:

and_chr 89
android 81
chrome 88
chrome 87
chrome 86
chrome 85
chrome 84
chrome 83
chrome 81
chrome 80
edge 85
edge 84
edge 18
firefox 86
firefox 85
firefox 84
firefox 83
firefox 82
firefox 81
firefox 80
firefox 79
firefox 78
firefox 77
firefox 76

Project documentation

All project documentation can be found under the docs/ directory. Make sure to update related documentation whenever possible. All documentation is published using Gitlab pages. You can preview a merge request’s changes to the documentation website using GitLab review environments. Wait for the MR’s CI pipeline to complete and click the “Deploy” button:

Review environment image

Note: The View latest app action will point to an older version of the deployed documentation for a particular merge request. In the example above, new changes were introduced in the merge request and not deployed yet.