Skip to content

Commit

Permalink
[docs] Adds a short doc about publishing new versions
Browse files Browse the repository at this point in the history
  • Loading branch information
jacomyal committed Mar 21, 2024
1 parent 5255861 commit 9aa57e8
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 1 deletion.
2 changes: 1 addition & 1 deletion packages/website/docs/advanced/migration-v2-v3.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Migrating from v2 to v3
sidebar_position: 6
sidebar_position: 7
---

This guide will help users migrating their applications from sigma v2.\* to v3.\*.
Expand Down
24 changes: 24 additions & 0 deletions packages/website/docs/advanced/publish.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
title: Publishing new versions
sidebar_position: 6
---

As the code is structured as a monorepo, we use [Lerna](https://github.com/lerna/lerna) to help version and publish the different packages handled in the repository.

To check packages that require a new version, you can run:

```bash
lerna version
```

This will ask you, for each package that has been edited since its last release, to specify a new version. Once it's done, a new commit has been added locally, with new tags, matching each package new version. It does not push by default.

To publish these new versions on [NPM](https://www.npmjs.com/), you can run:

```bash
lerna publish from-package
```

Once you validate the new versions to publish, it will publish each of these versions to NPM.

If you name your remote differently than `origin`, you need to add the option `--git-remote=<REMOTE_NAME>` to both commands;

0 comments on commit 9aa57e8

Please sign in to comment.