Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: examples to demonstrate the usage of changeset #3

Closed
wants to merge 1 commit into from
Closed

feat: examples to demonstrate the usage of changeset #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 0 additions & 16 deletions .changeset/heavy-tigers-sell.md
View file
Open in desktop

This file was deleted.

10 changes: 0 additions & 10 deletions .changeset/lucky-pears-listen.md
View file
Open in desktop

This file was deleted.

18 changes: 18 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,23 @@
# CHANGELOG

## 3.1.0

### Minor Changes

- [#2](https://github.com/ruanyl/OpenSearch-Dashboards/pull/2) [`643e516873`](https://github.com/ruanyl/OpenSearch-Dashboards/commit/643e516873d36c39c77a30c817c0c7ded1c2463d) Thanks [@ruanyl](https://github.com/ruanyl)! - 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
```

Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)

## [Unreleased]
Expand Down
4 changes: 2 additions & 2 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
"dashboarding"
],
"private": true,
"version": "3.0.0",
"version": "3.1.0",
"branch": "main",
"types": "./opensearch_dashboards.d.ts",
"tsdocMetadata": "./build/tsdoc-metadata.json",
Expand Down Expand Up @@ -241,7 +241,7 @@
"@osd/eslint-import-resolver-opensearch-dashboards": "2.0.0",
"@osd/eslint-plugin-eslint": "1.0.0",
"@osd/expect": "1.0.0",
"@osd/opensearch": "1.0.0",
"@osd/opensearch": "1.0.1",
"@osd/opensearch-archiver": "1.0.0",
"@osd/optimizer": "1.0.0",
"@osd/plugin-generator": "1.0.0",
Expand Down
12 changes: 12 additions & 0 deletions packages/osd-opensearch/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# @osd/opensearch

## 1.0.1

### Patch Changes

- [#2](https://github.com/ruanyl/OpenSearch-Dashboards/pull/2) [`643e516873`](https://github.com/ruanyl/OpenSearch-Dashboards/commit/643e516873d36c39c77a30c817c0c7ded1c2463d) Thanks [@ruanyl](https://github.com/ruanyl)! - 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.
2 changes: 1 addition & 1 deletion packages/osd-opensearch/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@osd/opensearch",
"main": "./target/index.js",
"version": "1.0.0",
"version": "1.0.1",
"license": "Apache-2.0",
"private": true,
"opensearchDashboards": {
Expand Down