Skip to content

Latest commit

 

History

History
95 lines (59 loc) · 2.35 KB

DEVELOPER.md

File metadata and controls

95 lines (59 loc) · 2.35 KB

Development

This document describes how you can create, lint, test, build and publish packages in this project.

Prerequisite

Before you can start you must install and configure the following products on your development machine:

You will then need to clone this project and install the required dependencies:

git clone <repository_url> <dir_name>
cd <dir_name>
npm install

Creating a new package

  1. Create a new package using the built-in schematic tool:

    npm run new-package

  2. Reorder alphabetically what was generated in README.md and .github/workflows/ci_release.yml.

  3. If this new package has any other internal packages as peer dependencies:

    • Make sure that this new package is also tested during the tests of the other packages
      (have a look at ci_test_core.yml for examples)

Linting/verifying source code

Check that the code is properly formatted and adheres to coding style.

npm run lint

You can also verify it per package:

npm run lint -w projects/<package_name>

Unit testing a package

Unit testing a package can be executed with the following command:

npm run test -w projects/<package_name>

Building a package

Building a package can be executed with the following command:

npm run build -w projects/<package_name>

Publishing a package to NPM repository

This project comes with automatic continuous delivery (CD) using GitHub Actions.

To publish a package:

  1. Trigger a new workflow release
  2. Watch the results in: Actions

⚠️ First release

A previous tag needs to be found to compute the next semver version.

When you publish a package for the first time, you will have to do the following:

  1. Commit and push the package, using this commit message:

    feat(<package_name>): first commit

  2. Add a tag to the commit prior to the one you just created, and push it:

    @hug/ngx-<package_name>@1.0.0

  3. Trigger a new release

  4. Once done, remove the tag you previously created