Skip to content

Latest commit

 

History

History
50 lines (31 loc) · 2.81 KB

RELEASE.md

File metadata and controls

50 lines (31 loc) · 2.81 KB
Raw

How to release

To release new versions of our package we use a Github action that triggers on the creation of a new Github release. As we use pnpm to manage our monorepo the pnpm publish command is used in this Github action and will release all the packages not flagged with the private property in the package.json The released packages are :

  • @prestashopcorp/puik-components
  • @prestashopcorp/puik-web-components
  • @prestashopcorp/puik-resolver
  • @prestashopcorp/puik-theme
  • @prestashopcorp/puik-tailwind-preset
  • @prestashopcorp/puik

ℹ️ Only packages whose version has been bumped will be published in the npm registry (see below):

1 - Versioning with changset

⚠️ Be careful, this is an important step :

Before creating a release on github, you must bump the versions of the packages that have been modified with Changeset otherwise packages whose versions have not been changed will not be published to the npm registry. For the moment this step is not yet automated and the following steps will need to be carried out.

Here are the steps to follow:

  1. To generate a new changeset, create a branch from main to bumped versions.

  2. Run pnpm changeset in the root of the repository. The generated markdown files in the .changeset directory should be committed to the repository.

  3. Run pnpm changeset version. This consumes all changesets, and updates automatically to the most appropriate semver version based on those changesets. It also writes changelog entries for each consumed changeset.

  4. Run pnpm install. This will update the lockfile and rebuild packages.

  5. Commit the changes and create a new Pull Request to main branch.

  6. Merge Pull Request to main branch and then you can create a new release from github (see next step).

2 - Use github release system

You can find the link Create a new release on the right on this page or you can use directly this link.

Once you clicked on, you have to create a tag by clicking on Choose a tag, write your tag name like vX.X.X by respecting the semantic versioning.

Make sure that main is selected as Target.

Set the Release title as the version of your tag vX.X.X and for the description you have to click on Generate release notes.

And finally you can smash the Publish release button.

The packages will be pushed to npm publicly.

NB: Only bumped packages with changeset are published (During version changes only the global puik package changes each time and is supposed to follow the github release number but the version numbers for individual packages are therefore not necessarily the same as the github release version).