Skip to content

Latest commit

 

History

History
131 lines (99 loc) · 4.3 KB

README.md

File metadata and controls

131 lines (99 loc) · 4.3 KB
Raw

Kalos

This yarn monorepo contains a variety of packages that are published to npm.

Packages

License

MIT License

Contributing

Contributions are encouraged, please see further details below:

Working With Packages

The is a yarn monorepo, therefore scripts in packages can be executed by pre-pending the command with yarn workspace and specifying the name of the package, e.g.

  • Build grpc-boom: yarn workspace grpc-boom build
  • Lint grpc-boom: yarn workspace grpc-boom lint
  • Test grpc-boom: yarn workspace grpc-boom test:unit

Tip: add yarn workspace as an alias to your .bashrc / .zshrc, e.g.

alias yw='yarn workspace'

Creating Package Scoped Commits

In order to assist with changelog generation, this repository uses conventional commit, changes to a package should adhere to this style and include the name of the package, e.g.

  • chore(grpc-boom): set package.json version 3.0.9
  • docs(heart-ping): add contribution guidelines
  • feat(node-ts-uuid): initial migration

Sharing Packages In The Monorepo

Packages can be imported / shared within the monorepo, either using the workspace protocol, the link protocol, or requiring the npm version.

  • npm: Resolves from the npm registry, e.g. "grpc-boom": "npm:^3.0.9"
  • link: Creates a link to a relative folder, e.g. "grpc-boom":"link:../grpc-boom/src"
  • workspace: Creates a link to a package in a workspace e.g. "kalos": "workspace:*"

Package Resolution (Workaround)

The grpc-ts-health-check package uses the grpc-boom package, but because it is in the workspace yarn does not download the dependency from npm. To ensure the package is correctly resolved the following configuration is required:

"dependencies": {
  "grpc-boom": "npm:^3.0.9"
},
"devDependencies": {
  "grpc-boom": "link:../grpc-boom/src"
}

The grpc-boom package can now be resolved locally and when published.

Release Workflow

Each package in this repository has a base workflow, e.g. .github/workflows/grpc-boom.yaml. The base workflow is triggered on each pull-request or push to the main branch based on specific paths, e.g.

on:
  push:
    branches:
      - main
    paths:
      - .github/workflows/grpc-boom.yaml
      - packages/grpc-boom/**
      - package.json
      - tsconfig.json
      - types/**/*.ts
      - '!**.md'
      - '!**/.gitignore'
  pull_request:
    paths:
      - .github/workflows/grpc-boom.yaml
      - packages/grpc-boom/**
      - package.json
      - tsconfig.json
      - types/**/*.ts
      - '!**.md'
      - '!**/.gitignore'

When the workflow is triggered, the first step usually executes build, lint and test operations, if this step succeeds it triggers the next step: draft-release which creates a draft release in kalos.

Publishing

To publish a package to npm one of the draft releases needs to be published:

  1. Navigate to the releases page.
  2. Edit one of the draft releases.
  3. Fill-in the release notes.
  4. Click on the green Publish release button.

This will trigger the the .github/workflows/publish.grpc-boom.yaml workflow by pushing a new tag to the repository. The publish workflow updates the version of the package in the package.json file, and pushes the new version to npm.

Pull Requests

Here are some basic rules to follow to ensure timely addition of your request:

  1. Match coding style (braces, spacing, etc.).
  2. If it is a feature, bugfix, or anything please only change the minimum amount of code required to satisfy the change.
  3. Please keep PR titles easy to read and descriptive of changes, this will make them easier to merge.
  4. Pull requests must be made against the main branch. Any other branch (unless specified by the maintainers) will get rejected.
  5. Check for existing issues first, before filing a new issue.