2.7.0 • Published 4 years ago

@codecademy/gamut-templates v2.7.0

Weekly downloads
282
License
MIT
Repository
github
Last release
4 years ago

CLIENT MODULES

Shared node modules for codecademy.com & co


CircleCI codecov

This repository is a monorepo that we manage using Lerna. That means that we publish several packages to npm from the same codebase, including:

gamut: Our React UI component library

gamut-styles: Utility styles for gamut components and codecademy apps

gamut-icons: SVG Icons for gamut components and codecademy apps

gamut-storybook: A component development sandbox for Gamut components

Local development

  1. Run yarn in the root directory
  2. Run yarn lerna bootstrap to prep each package in the packages directory for development

Running storybook

  1. Run yarn start to start the storybook server
  2. Add new stories to workspaces/gamut-storybook/stories
  3. Stories are written using storybook's Component Story Format

Publishing Modules

  1. Make your changes in a feature branch, and get another engineer to review your code
  2. After you've reviewed and tested your code, you can merge your branch into master.
  3. To merge, use the "squash and merge" button in github
  4. To generate an entry in the changelog for the module you changed, follow the commit message guide
  5. Once your branch is merged into master, it will be published automatically by CircleCI.
  6. You can check the master branch or CircleCI for the new version number

Publishing an alpha version of a module

Every PR that changes files in a package publishes alpha releases that you can use to test your changes across applications

  1. Create a PR
  2. In the github "checks" UI, find the "Publish Alpha" task
  3. Once this check has passed, click on it, and look through the output for the alpha version number
  4. Use this version in the other application you want to test your changes on

Commit Message Guide

Commits follow the Angular format

Commit Format

The squash and merge commit should follow a convention:

type(scope): message

Examples:

fix: fixes some component
test: adds test to component
feat(component): :sparkles: An awesome new component

This message should go inside the title field of the message:

screen shot 2019-03-04 at 10 41 07 am

Type

The type determines what kind of version bump is needed. A fix will create a patch release, while a feat will create a minor release. Major releases are only created when the text BREAKING CHANGE: is included in the Body or Footer of the commit message.

type must be one of the following:

  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  • docs: Documentation only changes
  • feat: A new feature
  • fix: A bug fix
  • perf: A code change that improves performance
  • refactor: A code change that neither fixes a bug nor adds a feature
  • test: Adding missing tests or correcting existing tests
  • ci: Changes to our CI configuration files and scripts
  • build: Changes that affect the build system or external dependencies

Scope

Optional scope for your changes

Body

Optional extra description for your changes

This is where you should describe any version breaking changes by including the text BREAKING CHANGE: with your description.

Publishing the storybook

  1. Storybook is built and published automatically when there are merges into the master branch
2.7.0

4 years ago

2.6.5

4 years ago

2.6.6

4 years ago

2.6.3

4 years ago

2.6.2

4 years ago

2.6.4

4 years ago

2.6.1

4 years ago

2.6.0

4 years ago

2.5.7

4 years ago

2.5.6

4 years ago

2.5.5

4 years ago

2.5.4

4 years ago

2.5.2

4 years ago

2.5.3

4 years ago

2.5.1

4 years ago

2.5.0

4 years ago

2.3.4

4 years ago

2.3.3

4 years ago

2.3.2

4 years ago

2.3.1

4 years ago

2.3.0

4 years ago

2.2.35

4 years ago

2.2.33

4 years ago

2.2.34

4 years ago

2.2.32

4 years ago

2.2.31

4 years ago

2.2.29

4 years ago

2.2.30

4 years ago

2.2.28

4 years ago

2.2.27

4 years ago

2.2.26

4 years ago

2.2.25

4 years ago

2.2.24

4 years ago

2.2.23

4 years ago

2.2.22

4 years ago

2.2.21

4 years ago

2.2.20

4 years ago

2.2.19

4 years ago

2.2.18

4 years ago

2.2.17

4 years ago

2.2.16

4 years ago

2.2.15

4 years ago

2.2.13

4 years ago

2.2.14

4 years ago

2.2.12

4 years ago

2.2.11

4 years ago

2.2.10

4 years ago

2.2.9

4 years ago