Skip to content

Latest commit

 

History

History
65 lines (48 loc) · 2.53 KB

package-publishing.md

File metadata and controls

65 lines (48 loc) · 2.53 KB
Raw

Package publishing

The publishing is applied to external packages. The next ones:

  • packages/simple-pie
  • packages/react-simple-pie

Building

tsup is used for package building.
module-systems

Versioning

The version is composed of three numbers: major.minor.patch . The version is incremented according to the following rules:

  • Patch : The patch number increases when the package undergoes modifications that are backward compatible. This typically includes bug fixes or documentation updates.
  • Minor : A minor version increment occurs when the package undergoes modifications that are backward compatible. This may involve adding new features or modifying existing ones in a way that maintains backward compatibility.
  • Major : The major version number increases when the package undergoes modifications that are not backward compatible. This includes actions such as removing features or modifying existing ones in a manner that breaks backward compatibility.

Publishing

The project packages follow an automation changeset release flow.
It uses the github action to your repository in the CI pipeline.

sequenceDiagram
    actor C as Contributor
    participant PR as Pull request
    participant M as master
    participant GA as GitHub action
    participant NPM
    Note over C,NPM: Contribution
    C->>M: package update/fix
    M--xGA: ignored
    Note over C,NPM: Release
    C->>M: create changeset
    M-->>GA: changeset detected
    GA->>PR: The release PR: Increment version, delete changeset file
    C-->>PR: Approve/merge the release PR
    PR->>M: merge the release PR
    M-->>GA: the updated version detected
    GA->> NPM: publish
Loading

A changeset is a file that documents the alterations made to the package. This file serves as a record of modifications, changelogs and the version incrementation process for the package.

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

npm run changeset

This command initiates an interactive prompt, which assists in defining changes for each package within the monorepo.

Subsequently, it generates a changeset file in the .changeset directory. The file will include the changes was made.

When a changeset is pushed to the repository, the GitHub action will create a separate PR with changelog and incremented version of the package.

After the PR is merged successfully, the package is automatically pushed to npm.