diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f4a0bd6a0..00f37bcf4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -36,7 +36,7 @@ To publish a new version of a package, or to publish a new package: 1. Version commits _should_ be managed as part of your package update PR in most cases 2. Increment either the major, minor, or patch version in the relevant `package.json`. If you're unsure which, have a chat about it or re-read the semver docs * Development versions of a package should start at version `0.1.0` as per the [semver documentation](https://semver.org/#spec-item-4) -3. Add an entry to the relevant `HISTORY.md` file outlining the changes in the new version. Take your time, this log should be useful to developers – it should help them make decisions about whether they can upgrade. If this file is not updated then travis will fail the build. +3. Add an entry to the relevant `HISTORY.md` file outlining the changes in the new version. Take your time, this log should be useful to developers – it should help them make decisions about whether they can upgrade. If this file is not updated then GitHub Actions will fail the build. 4. (Make sure you only publish one package at a time) 6. Code review your pull request and merge 7. The build system will automatically publish your new version based on the `package.json` version diff --git a/README.md b/README.md index d3e4ee756..679aff75d 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,14 @@ # Frontend Toolkits -[![Build Status][badge-build]][info-build] +![Build Status][badge-build] [![MIT licensed][badge-license]][info-license] [![Node version][badge-node]][info-node] [![SASS version][badge-sass]][info-sass] > Frontend Component Toolkits for the Elements Design System +[!IMPORTANT] There is a newer version of the [Elements Design System](https://github.com/springernature/elements/tree/main). Please make sure you are using the correct one. If you are unsure please speak to the Design System Team + * [Installation](#installation) * [Using the correct `node` & `npm` versions](#using-the-correct-node--npm-versions) * [Using the correct `sass` version](#using-the-correct-sass-version) @@ -63,7 +65,7 @@ Packages are bundles of front-end assets (HTML, CSS, JS, images, tests etc...) t ## Writing a package -All packages are validated on our CI server (Travis) to ensure they conform to certain naming conventions, file/folder structure, and that certain required files are present. +All packages are validated on GitHub Actions CI to ensure they conform to certain naming conventions, file/folder structure, and that certain required files are present. The validation is configurable in the `package-manager.json` files that can be found in the [repository root](package-manager.json) (this config is shared across all toolkits), and in the root folder for each toolkit. @@ -73,7 +75,7 @@ You can validate all the packages by running `npm run validate` from within the The creation, validation and publication of packages is controlled via the [Frontend Package Manager](https://github.com/springernature/frontend-package-manager). -The `README` for that repository provides information on the package creation wizard, which can be run with `npm run create`, as well as detailing additional options for package validation, as well how packages are [automatically published via Travis](#publishing). +The `README` for that repository provides information on the package creation wizard, which can be run with `npm run create`, as well as detailing additional options for package validation, as well how packages are [automatically published via GitHub Actions](#publishing). ### Package structure @@ -241,11 +243,11 @@ Javascript linting is enforced using the [Springer Nature Eslint config](https:/ ## Continuous integration -This repository uses [Travis CI](https://travis-ci.com/) and builds are run on all Pull Requests. On each build Travis will boostrap all of the package dependencies using `Lerna Boostrap`, before running linting and all tests. +This repository uses GitHub Actions and builds are run on all Pull Requests. On each build GitHub will boostrap all of the package dependencies using `Lerna Boostrap`, before running linting and all tests. ### Publishing -To publish a new package please follow the [contributing guidelines](CONTRIBUTING.md). Publishing to NPM is done automatically on Travis, which detects a new version in a packages `package.json` file, and a corresponding entry in the `HISTORY.md` file. +To publish a new package please follow the [contributing guidelines](CONTRIBUTING.md). Publishing to NPM is done automatically via GitHub Actions, which detects a new version in a packages `package.json` file, and a corresponding entry in the `HISTORY.md` file. ## License @@ -255,9 +257,8 @@ Copyright © 2020, Springer Nature [info-license]: LICENCE [badge-license]: https://img.shields.io/badge/license-MIT-blue.svg -[info-build]: https://travis-ci.com/springernature/frontend-toolkits -[badge-build]: https://badgen.net/travis/springernature/frontend-toolkits?icon=travis +[badge-build]: https://github.com/springernature/frontend-toolkits/actions/workflows/build.yml/badge.svg [info-node]: .nvmrc -[badge-node]: https://img.shields.io/badge/node--lts-%3E%3D%2014.19.1-brightgreen +[badge-node]: https://img.shields.io/badge/node--lts-%3E%3D%2018.x-brightgreen [info-sass]: #using-the-correct-sass-version [badge-sass]: https://img.shields.io/badge/SASS-1.47.0-green.svg