diff --git a/RELEASE.md b/RELEASE.md index c47bc97e..4a5be0c1 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -17,21 +17,21 @@ The released packages are : > ⚠️ **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](https://github.com/changesets/changesets). -> -> For the moment this step is not yet automated and the following steps will need to be carried out. +> Before creating a release on github, you must bump the versions of the packages that have been modified with [Changeset](https://github.com/changesets/changesets) 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: +**Here are the steps to follow:** -1. To generate a new changeset, run `pnpm changeset` in the root of the repository. The generated markdown files in the .changeset directory should be committed to the repository. +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. -2. Run `pnpm changeset version`. This consumes all changesets, and updates to the most appropriate semver version based on those changesets. It also writes changelog entries for each consumed changeset. +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. -3. Run `pnpm install`. This will update the lockfile and rebuild packages. +4. Run `pnpm install`. This will update the lockfile and rebuild packages. -4. Commit the changes and create a new Pull Request to `main` branch. +5. Commit the changes and create a new Pull Request to `main` branch. -5. Merge Pull Request to `main` branch and then you can create a new release from github (see next step). +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 @@ -46,3 +46,5 @@ Set the `Release title` as the version of your tag `vX.X.X` and for the descript 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).