alphagov / govuk_frontend_toolkit_npm

An npm package for alphagov/govuk_frontend_toolkit

The GOV.UK Design System launched on 22 June 2018

GOV.UK Frontend Toolkit has now been replaced by the GOV.UK Design System. The Toolkit will remain available in case you are currently using it, but is no longer maintained. The Government Digital Service will only carry out major bug fixes and security patches.

The GOV.UK Design System will be updated to ensure the things it contains meet level AA of WCAG 2.1, but GOV.UK Frontend Toolkit will not. Read more about accessibility of the GOV.UK Design System.

---

GOV.UK frontend toolkit npm package

This is an npm package for the GOV.UK frontend toolkit. It bundles up the toolkit and publishes govuk_frontend_toolkit on the npmjs registry so that you can install it as a dependency in your JavaScript application.

Installing

To include the toolkit in your project run:

npm install --save govuk_frontend_toolkit

This will install the toolkit inside your node_modules and will add the package to your package.json.

Updating this package

All development of the toolkit should happen upstream and changes will then become available in this package.

When master is changed in the upstream repo Travis will trigger a build of this repository, which will automatically build and publish the module if the version in VERSION.txt is newer than the version published on NPM registry.

Licence

MIT License

govuk_frontend_toolkit_npm's Issues

Don't package files that aren't needed

From the looks of it, parts of govuk_frontend_toolkit appear within the package – this includes all the documentation and the Gemfile and Gemfile.lock. We should probably remove some of these.

cc @robinwhittleton @dsingleton

Move SSH deploy setup into `publish.sh`

This is currently in before_install, has caused problems on other repos where tests running for forks will fail because a fork does not have access to the encryption env vars.

In other repos we've moved the SSH key setup into the script that requires it, for example: https://github.com/alphagov/govuk_frontend_toolkit/blob/master/create-release.sh. That avoids the issues with forks, and puts the SSH setup next to where it's used, which should make it easier to understand.

In this repo it makes sense to move that setup to publish.sh, as thats where we're using SSH config to push to github.

Add a README to `.travis`

We've done this on other repos and it makes it easier to explain how/why we're using encrypted files with Travis.

For this repo that should cover the format the npm provider api_key, mentioning how to get the API key and issues between npm versions. See https://docs.travis-ci.com/user/deployment/npm/