Skip to content

Commit

Permalink
docs(package-publishing): add changesets flow diagram
Browse files Browse the repository at this point in the history
  • Loading branch information
serjilyashenko authored Mar 31, 2024
1 parent b1e6e50 commit 7e7c254
Showing 1 changed file with 21 additions and 2 deletions.
23 changes: 21 additions & 2 deletions docs/package-publishing.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,27 @@
The project packages follow an automation changeset release flow.\
It uses the [github action](https://github.com/changesets/action) to your repository in the CI pipeline.

```mermaid
sequenceDiagram
actor C as Contributor
participant PR as Pull request
participant GA as GitHub action
participant M as master
participant NPM
Note over C,NPM: Contribution
C->>M: package update/fix
Note over C,NPM: Release
C->>M: create changeset
activate GA
GA->>PR: Increment version, delete changeset file
deactivate GA
C->>PR: Approve/merge release PR
PR->>M: merge
activate GA
GA->> NPM: publish
deactivate GA
```

To start releasing new npm package version use the following command:

```bash
Expand All @@ -13,5 +34,3 @@ npm run changeset

This command will open an interactive prompt that guides through the process of defining changes for each package in
the monorepo.

🚧TBD

0 comments on commit 7e7c254

Please sign in to comment.