-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
73 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,73 @@ | ||
### Package update | ||
|
||
Run the following command to update the package: | ||
|
||
```bash | ||
yarn changeset | ||
``` | ||
|
||
Then follow the instructions in the terminal: | ||
|
||
```bash | ||
π¦ What kind of change is this for logos? (current version is x.x.x) | ||
β― patch | ||
minor | ||
major | ||
``` | ||
|
||
```bash | ||
π¦ Please enter a summary for this change (this will be in the changelogs). | ||
π¦ (submit empty line to open external editor) | ||
π¦ Summary βΊ [CHANGES] | ||
``` | ||
After that, you will be asked to confirm the changeset: | ||
```bash | ||
π¦ Summary βΊ [CHANGES] | ||
π¦ | ||
π¦ === Summary of changesets === | ||
π¦ patch: logos | ||
π¦ | ||
π¦ Is this your desired changeset? (Y/n) βΊ true | ||
``` | ||
If you confirm, the changeset will be created and you will be asked to publish it: | ||
```bash | ||
π¦ Changeset added! - you can now commit it | ||
π¦ | ||
π¦ If you want to modify or expand on the changeset summary, you can find it here | ||
π¦ info .changeset/[MD_FILE] | ||
β¨ Done. | ||
``` | ||
Commit the changeset and push it to the repository: | ||
```bash | ||
git add . | ||
git commit -m "chore: update logos" | ||
git push | ||
``` | ||
Merge the changeset to the main branch: | ||
```bash | ||
git checkout main | ||
git merge [BRANCH_NAME] | ||
git push | ||
``` | ||
To publish the package, merge main to the `production` branch: | ||
```bash | ||
git checkout production | ||
git merge main | ||
git push | ||
``` | ||
Changeset will raise a PR to the `production` branch. After the PR is merged, the package will be published to npm. | ||
Following the publish `changeset` will update the `CHANGELOG.md` and `package.json` files in `production` branch. | ||
Merge the `production` branch to the `main` branch to keep the `main` branch up to date. |