Skip to content

Commit

Permalink
Merge pull request #11 from babylonlabs-io/update-changeset-readme
Browse files Browse the repository at this point in the history
update changeset readme
  • Loading branch information
jeremy-babylonlabs authored Nov 21, 2024
2 parents 9d4c462 + 54bc03e commit fd5d3d0
Show file tree
Hide file tree
Showing 4 changed files with 46 additions and 1 deletion.
22 changes: 22 additions & 0 deletions .changeset/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,25 @@ find the full documentation for it [in our repository](https://github.com/change

We have a quick list of common questions to get you started engaging with this project in
[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)

# Usage
1. `npx changeset` to create a changeset

2. Select change type:

Major:
- Describes when to use a major change, focusing on breaking changes.

Minor:
- Describes when to use a minor change, focusing on new features that are backward compatible.

Patch:
- Describes when to use a patch change, focusing on bug fixes and small improvements.

3. edit the file in .changeset for further details
4. `npx changeset version` to update the package version
5. Input Summary
6. Confirm changeset
7. Generated changeset is generated under .changeset dir
8. Commit change
9. Merge PR on github
16 changes: 16 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,19 @@ jobs:
publish: ${{ github.event_name == 'workflow_dispatch' }}
publish-command: |
npm run release
check_version_change:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v2

- name: Check for version change
id: version_check
run: |
git fetch origin main
git diff origin/main -- package.json | grep '"version":' || echo "No version change detected"
- name: Conditional Release
if: steps.version_check.outputs.version_changed == 'true'
run: npm run release
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# @babylonlabs-io/bbn-core-ui

## 0.0.5

### Patch Changes

- add changeset flow

## 0.0.1

### Patch Changes
Expand Down
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@babylonlabs-io/bbn-core-ui",
"version": "0.0.4",
"version": "0.0.5",
"type": "module",
"types": "dist/index.d.ts",
"publishConfig": {
Expand All @@ -27,6 +27,7 @@
"storybook": "storybook dev -p 6006",
"build-storybook": "storybook build",
"prepare": "husky",
"changeset": "npx changeset && changeset version",
"release": "npm run build && changeset publish"
},
"files": [
Expand Down

0 comments on commit fd5d3d0

Please sign in to comment.