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

Add MAINTAINING.md #150

Merged
merged 1 commit into from
Aug 6, 2024
Merged

Add MAINTAINING.md #150

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
31 changes: 31 additions & 0 deletions MAINTAINING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Maintaining yorkie-ui

## Releasing a New Version

### 1. Update the version number.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove trailing punctuation in the heading.

The heading should not have trailing punctuation.

-### 1. Update the version number.
+### 1. Update the version number
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
### 1. Update the version number.
### 1. Update the version number
Tools
Markdownlint

5-5: Punctuation: '.'
Trailing punctuation in heading

(MD026, no-trailing-punctuation)


- Update `version` in [package.json](https://github.com/yorkie-team/yorkie-ui/blob/main/package.json#L3).
- Run `pnpm run version` to synchronize the versions of sub-packages with the root version.
- Create [Pull Request](https://github.com/yorkie-team/yorkie-ui/commits/main/package.json) and merge it into main.

### 2. Publish a new release.

1. Click on `Releases` in GitHub, then click the `Draft a new release` button.

Alternatively, you can directly access this link: https://github.com/yorkie-team/yorkie-ui/releases/new
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Format the bare URL correctly.

The bare URL should be formatted as a proper link.

- Alternatively, you can directly access this link: https://github.com/yorkie-team/yorkie-ui/releases/new
+ Alternatively, you can directly access this link: [GitHub Releases](https://github.com/yorkie-team/yorkie-ui/releases/new)
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
Alternatively, you can directly access this link: https://github.com/yorkie-team/yorkie-ui/releases/new
Alternatively, you can directly access this link: [GitHub Releases](https://github.com/yorkie-team/yorkie-ui/releases/new)
Tools
Markdownlint

15-15: null
Bare URL used

(MD034, no-bare-urls)


![image](https://github.com/user-attachments/assets/03f5cf54-eafe-4577-84a4-e4d1d7f8c7bf)

2. Create a new tag.

![image](https://github.com/user-attachments/assets/ef34bd77-3d7b-4111-93a6-2408be0777d2)

3. Click the `Generate release notes` button.

![image](https://github.com/user-attachments/assets/78fc240c-385c-414e-a7a3-03b73a31254b)

4. Click the `Publish release` button.

### 3. Deploy

When you publish the release, [GitHub action](https://github.com/yorkie-team/yorkie-ui/blob/main/.github/workflows/npm-publish.yml) will automatically deploy Yorkie UI to [npm](https://www.npmjs.com/package/@yorkie-ui/core).
2 changes: 1 addition & 1 deletion apps/storybook/src/stories/Introduction.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ npm install --save @yorkie-ui/core
Add styles imports to the root of your project.

```
import '@yorkie-ui/core/dist/styles.css';
import '@yorkie-ui/core/styles.css';

```

Expand Down
2 changes: 1 addition & 1 deletion packages/core/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Import the styles and components you need from `@yorkie-ui/core`:

```tsx
// import the styles
import '@yorkie-ui/core/dist/styles.css';
import '@yorkie-ui/core/styles.css';

// import button component
import { Button } from '@yorkie-ui/core';
Expand Down
Loading