Skip to content

Commit

Permalink
feat: examples to demonstrate the usage of changeset
Browse files Browse the repository at this point in the history
Signed-off-by: Yulong Ruan <ruanyl@amazon.com>
  • Loading branch information
ruanyl committed Jan 26, 2023
1 parent e17cac3 commit 643e516
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 0 deletions.
16 changes: 16 additions & 0 deletions .changeset/heavy-tigers-sell.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
'opensearch-dashboards': minor
---

## This is an example of using changeset

In this example, there are some changes to `opensearch-dashboards`. But this is
just for demo, there is no changes to the actual files.

This is a example to demonstrate the idea of using changeset to manage
changelog without tears.

The changeset file is a regular markdown file, we can use markdown syntax:
```
yarn changeset add
```
10 changes: 10 additions & 0 deletions .changeset/lucky-pears-listen.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
'@osd/opensearch': patch
---

## Another example to demonstrate changes to workspace packages

In this example, there are some changes to package `@osd/opensearch`. But this is
just for demo, there is no changes to the actual files.

Ideally, we want to document each and every changes clearly of each package.

0 comments on commit 643e516

Please sign in to comment.