forked from opensearch-project/OpenSearch-Dashboards
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: examples to demonstrate the usage of changeset
Signed-off-by: Yulong Ruan <ruanyl@amazon.com>
- Loading branch information
Showing
2 changed files
with
26 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,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 | ||
``` |
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,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. |