Pre-release Features

Using a pre-release feature

Often times, a subteam within the Pragiti team will need to work on a feature using updated components from this library which have not been released for production (i.e. they’ve not been merged to master). The way to get those features is to update package.json to point to the feature branch created for that pre-release feature. For example:

  "dependencies": {
    // ...
    "maui-jim-styleguide": "git+ssh://git@github.com/ChromaticHQ/maui-jim-styleguide.git#BRANCH_NAME"
  },

Where BRANCH_NAME is the full branch name as provided to you by Chromatic. Typically, it will be something like this:

pre-release/GH-9999-some-feature-name

It’s important to keep in mind that once you are ready to merge your work into the development branch for the next Production build, you should notify Chromatic of this so that the following takes place:

  1. Chromatic merges the Pre-release feature to master, which gets rolled into the next release of this Styleguide.
  2. You update your package.json to point back at master:
       "dependencies": {
         // ...
         "maui-jim-styleguide": "git+ssh://git@github.com/ChromaticHQ/maui-jim-styleguide.git"
       },
  3. You re-install and re-build the component library, and commit the resulting changes.
  4. You merge your feature branch into your development branch.