Skip to content

Commit

Permalink
docs: developer
Browse files Browse the repository at this point in the history
  • Loading branch information
Badisi committed Jun 26, 2024
1 parent 5ba606e commit 8ca4de4
Showing 1 changed file with 28 additions and 2 deletions.
30 changes: 28 additions & 2 deletions DEVELOPER.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,17 @@ npm install

## Creating a new package

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

```sh
run run new-package
```

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](https://github.com/DSI-HUG/ngx-components/blob/main/.github/workflows/ci_test_core.yml#L27-L29) for examples)*

## Linting/verifying source code

Check that the code is properly formatted and adheres to coding style.
Expand All @@ -47,7 +52,7 @@ Unit testing a package can be executed with the following command:
npm run test -w=projects/<package_name>
```

## Building a package
## Building a package

Building a package can be executed with the following command:

Expand All @@ -59,9 +64,30 @@ npm run build -w=projects/<package_name>

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

To publish a package:

1. Trigger a new: [Workflow release](https://github.com/dsi-hug/ngx-components/actions/workflows/ci_release.yml)
2. Watch the results in: [Actions](https://github.com/dsi-hug/ngx-components/actions)

### ⚠️ First release

> A previous tag needs to be found to compute the next semver version.
So 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:
```sh
feat(<package_name>): first commit
```

2. Add a tag to the commit prior the one you just created, and push it:
```sh
@hug/ngx-<package_name>@1.0.0
```

3. Trigger a new release

4. Once done, remove the tag you previously created


[git]: https://git-scm.com/
Expand Down

0 comments on commit 8ca4de4

Please sign in to comment.