Skip to content

Commit

Permalink
Add update instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
hiletmis committed Feb 7, 2024
1 parent cd1a93e commit 20a5cd6
Showing 1 changed file with 73 additions and 0 deletions.
73 changes: 73 additions & 0 deletions .changeset/README.md
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.

0 comments on commit 20a5cd6

Please sign in to comment.