greenline-shared

This is the mono-repo for Greenline's shared packages. Deploys are managed through Lerna and Yarn Workspaces Commits are using conventional-changelog through Commitizen

/packages contains the different domains in Greenline. This will grow and spread out as services become larger and more comprehensive

Setup

• yarn install
• yarn bootstrap will set things up
• yarn watch will watch all packages
• yarn lint will lint all packages. Linting is also ran when committing changes

Committing changes

• stage your files
• git commit - This will start the interactive Commitizen commit
  • Additionally this will run lint-staged which will lint and clean the code to our standards
• Answer the questions based on the scope of the changes. Confused? Ask the team
• git push
• When all changes are complete run yarn new-version
  • This will build CHANGELOG.md based on the commit messages

Locally linking packages to homi-web

• yarn build / yarn watch
• yarn link:all
• Run in homi-web
  • Already published and added packages:
    • yarn link @getgreenline/shared
  • Brand new packages that aren't published yet
    • yarn add file:<pwd-package-folder>
    • yarn link @getgreenline/shared

Current caveats - Multiple verisons of Axios seems to be a problem. Could use the @getgreenline/homi-shared version and then update that page.

Using published packages (IMPORTANT)

Once your greenline package is published, please ensure that

• ^ is added to the package version
• yarn upgrade --scope @getgreenline or yarn add <package-name> is run to update yarn.lock instead of manually changing the package version and running yarn install. The latter can cause the package to use versions of dependent packages like @getgreenline/shared

Example

• Before: @getgreenline/products@^3.0.2 uses @getgreenline/shared ^2.0.4 while @getgreenline/[email protected] uses @getgreenline/shared ^2.0.5
• After: both versions of @getgreenline/products use @getgreenline/shared ^2.0.5