gaia-server-utils v9.8.0

Gaia Server Utilities

Shared code across node.js repos/projects.

See Also Core API docs

For the most part, the Gaia Core API Docs also apply to this repo and should be followed here.

How to…

• run the tests: npm test
• measure code coverage: npm run coverage
• run static analysis lint: npm run lint

How to Release New Features

• Follow the general branching and PR process for regular features and fixes defined in the Core API Docs on git
• To test your version in feature branches of the other microservices
  • Commit a new package.json with your proposed new semver release version with -rc.1 suffix
  • tag that commit, for example
    • git tag v4.2.0-rc.1
  • push the commit and tag
    • git push origin my-feature-branch && git push --tags
  • This candidate release is now available for other repos to depend on in feature branches and have their unit tests pass
• When your feature branch is proven ready for release, PR it into dev
• When ready to release a new version, pull down the latest dev branch
• edit package.json and set the version field appropriately for the semver level of this release. Typically this will just be removing the '-rc.1' suffix.
  • commit this to dev and push straight to origin/dev. No pull request because we are about to PR into master anyway
• PR dev into master
• After the PR is merged into master, pull down latest master branch
• Tag the new merge commit with the semver v1.2.3 tag
  • Example: git tag 'v1.2.3'
• Push just the tag back to github with git push --tags
• The release is now available and services using gaia-server-utils as an npm dependency can install it referencing the new release tag