|elm-version||0.18.0 <= v < 0.19.0|
|Committed At||2018-10-12 08:24:27 UTC|
|wernerdegroot/listzipper||3.0.0 <= v < 4.0.0||3.2.0|
|tesk9/accessible-html-with-css||1.0.1 <= v < 2.0.0||1.0.1|
|tesk9/accessible-html||3.0.0 <= v < 4.0.0||3.1.0|
|rtfeldman/elm-css-util||1.0.2 <= v < 2.0.0||1.0.2|
|rtfeldman/elm-css-helpers||2.1.0 <= v < 3.0.0||2.1.0|
|rtfeldman/elm-css||13.1.1 <= v < 15.0.0||14.0.0|
|pablohirafuji/elm-markdown||2.0.4 <= v < 3.0.0||2.0.5|
|elm-lang/svg||2.0.0 <= v < 3.0.0||2.0.0|
|elm-lang/html||2.0.0 <= v < 3.0.0||2.0.0|
|elm-lang/core||5.1.1 <= v < 6.0.0||5.1.1|
|NoRedInk/view-extra||2.0.0 <= v < 3.0.0||2.0.0|
UI widgets we use.
We try to avoid breaking changes and the associated major version bumps in this package. The reason for that is to avoid the following scenario:
| x 4.6.0: Adding RadioButton widget | x 5.0.0: Breaking change in the TextArea widget | x 5.0.1: Styling fix in the Checkbox widget |
Suppose you just released version
5.0.1, a small styling fix in the checkbox widget, for a story you're working on. If the project you're working in currently pulls in
noredink-ui at version
4.x, then getting to your styling fix means pulling in a new major version of
noredink-ui. This breaks all
TextArea widgets across the project, so those will need to be fixed before you can do anything else, potentially a big effort.
To prevent these big Yaks from suddenly showing up in seemingly trivial tasks we prefer to avoid breaking changes in the package. Instead when we need to make a breaking change in a widget, we create a new module for it
lib/MyWidget/VX.js and define a custom element
We should change this process if we feel it's not working for us!
If you are moving in a widget from the monolith:
Nri.SomeModuleand its tests to
Nri.Ui.SomeModule.V1is a direct copy of
Nri.SomeModule, switch over to it everywhere!
Nri.Ui.SomeModule.V1makes changes, rename
Nri.DEPRECATEDSomeModulein the monolith and start using
Nri.Ui.SomeModule.V1where you need it
Our goal is to gradually move to the newest version of each widget, and remove the old versions when they are no longer used.
noredink-ui is used by the monolith and by CCS. When neither of these repos use a version of a widget, it can be deleted. (Note: this will be a major version bump, so you may want to batch deletions together.)
When touching code that uses a widget, prefer upgrading to the latest version.
This repo contains an app showcasing all of these UI widgets.
To see them locally:
styleguide-app/index.html in your browser.
Alternatively, you may use elm-reactor. Please be aware that you'll need to globally install fonts (in particular, Muli) if you go this route.
If you'd like to test your widget in the monolith before publishing, check out the helpful tips here.
Run tests with
Travis will run
make ci to verify everything looks good.
You can run this locally to catch errors before you push!
Once you are ready to publish
master as a new version, run the following to bump the version in
Commit to a branch and open a pull request. Announce the PR in #eng-front-ops-changes to have it reviewed and merged to
master. Now you can publish the package!
elm-package publish # requires a tag, see below
This will require a tag, so follow the instructions it provides. It should be something like this:
Verifying NoRedInk/noredink-ui 5.10.0 ... Version number 5.10.0 verified (MINOR change, 5.9.1 => 5.10.0) Error: Libraries must be tagged in git, but tag 5.10.0 was not found. These tags make it possible to find this specific version on GitHub. To tag the most recent commit and push it to GitHub, run this: git tag -a 5.10.0 -m "release version 5.10.0" git push origin 5.10.0
You can also add a tag in https://github.com/NoRedInk/noredink-ui/releases/new if you want to add more detail.
Once you've published, you should see the latest version at the top of http://package.elm-lang.org/packages/NoRedInk/noredink-ui/latest.