Skip to content

Commit 6fb993f

Browse files
authored
chore: remove legacy release-it dependency (#399)
1 parent ef09d7f commit 6fb993f

4 files changed

Lines changed: 37 additions & 1875 deletions

File tree

CONTRIBUTING.md

Lines changed: 5 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -55,19 +55,6 @@ To edit the Objective-C files, open `example/ios/LivekitReactNativeExample.xcwor
5555

5656
To edit the Kotlin files, open `example/android` in Android studio and find the source files at `livekitreactnative` under `Android`.
5757

58-
### Commit message convention
59-
60-
We follow the [conventional commits specification](https://www.conventionalcommits.org/en) for our commit messages:
61-
62-
- `fix`: bug fixes, e.g. fix crash due to deprecated method.
63-
- `feat`: new features, e.g. add new method to the module.
64-
- `refactor`: code refactor, e.g. migrate from class components to hooks.
65-
- `docs`: changes into documentation, e.g. add usage example for the module..
66-
- `test`: adding or updating tests, e.g. add integration tests using detox.
67-
- `chore`: tooling changes, e.g. change CI config.
68-
69-
Our pre-commit hooks verify that your commit message matches this format when committing.
70-
7158
### Linting and tests
7259

7360
[ESLint](https://eslint.org/), [Prettier](https://prettier.io/), [TypeScript](https://www.typescriptlang.org/)
@@ -78,14 +65,16 @@ Our pre-commit hooks verify that the linter and tests pass when committing.
7865

7966
### Publishing to npm
8067

81-
We use [release-it](https://github.com/release-it/release-it) to make it easier to publish new versions. It handles common tasks like bumping version based on semver, creating tags and releases etc.
68+
We use [Changesets](https://github.com/changesets/changesets) to manage versioning and releases.
8269

83-
To publish new versions, run the following:
70+
If your pull request includes user-facing changes, add a changeset describing the change:
8471

8572
```sh
86-
yarn release
73+
yarn changeset
8774
```
8875

76+
When changesets are merged to `main`, the [Release workflow](.github/workflows/changeset.yaml) opens a "Version Packages" pull request. Merging that PR bumps the version, publishes to npm, and creates a GitHub release.
77+
8978
### Scripts
9079

9180
The `package.json` file contains various scripts for common tasks:

docs/media/CONTRIBUTING.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -78,14 +78,16 @@ Our pre-commit hooks verify that the linter and tests pass when committing.
7878

7979
### Publishing to npm
8080

81-
We use [release-it](https://github.com/release-it/release-it) to make it easier to publish new versions. It handles common tasks like bumping version based on semver, creating tags and releases etc.
81+
We use [Changesets](https://github.com/changesets/changesets) to manage versioning and releases.
8282

83-
To publish new versions, run the following:
83+
If your pull request includes user-facing changes, add a changeset describing the change:
8484

8585
```sh
86-
yarn release
86+
yarn changeset
8787
```
8888

89+
When changesets are merged to `main`, the [Release workflow](.github/workflows/changeset.yaml) opens a "Version Packages" pull request. Merging that PR bumps the version, publishes to npm, and creates a GitHub release.
90+
8991
### Scripts
9092

9193
The `package.json` file contains various scripts for common tasks:

package.json

Lines changed: 0 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,6 @@
7878
"@livekit/react-native-webrtc": "^144.1.0",
7979
"@react-native/babel-preset": "0.83.0",
8080
"@react-native/eslint-config": "0.83.0",
81-
"@release-it/conventional-changelog": "10.0.1",
8281
"@types/fastestsmallesttextencoderdecoder": "^1.0.0",
8382
"@types/react": "^19.2.0",
8483
"commitlint": "^19.8.1",
@@ -92,7 +91,6 @@
9291
"react": "19.2.0",
9392
"react-native": "0.83.0",
9493
"react-native-builder-bob": "^0.40.17",
95-
"release-it": "^19.0.4",
9694
"typedoc": "^0.28.14",
9795
"typescript": "^5.9.2"
9896
},
@@ -108,7 +106,6 @@
108106
"typescript": "tsc --noemit -p tsconfig.build.json",
109107
"lint": "eslint \"**/*.{js,ts,tsx}\"",
110108
"prepare": "bob build",
111-
"release": "release-it",
112109
"example": "yarn --cwd example",
113110
"pods": "cd example && pod-install --verbose",
114111
"ci:version": "changeset version && yarn build-docs",
@@ -156,36 +153,6 @@
156153
]
157154
}
158155
},
159-
"release-it": {
160-
"hooks": {
161-
"before:init": [
162-
"yarn lint",
163-
"yarn test --passWithNoTests",
164-
"yarn typescript"
165-
],
166-
"after:bump": [
167-
"yarn pods",
168-
"yarn build-docs"
169-
],
170-
"after:release": "echo Successfully released ${name} v${version} to ${repo.repository}."
171-
},
172-
"git": {
173-
"commitMessage": "chore: release ${version}",
174-
"tagName": "v${version}"
175-
},
176-
"npm": {
177-
"publish": true
178-
},
179-
"github": {
180-
"release": true
181-
},
182-
"plugins": {
183-
"@release-it/conventional-changelog": {
184-
"preset": "angular",
185-
"ignoreRecommendedBump": true
186-
}
187-
}
188-
},
189156
"prettier": {
190157
"quoteProps": "consistent",
191158
"singleQuote": true,

0 commit comments

Comments
 (0)