-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
55 additions
and
1 deletion.
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,54 @@ | ||
# React Component Library - Release Guide | ||
|
||
This guide outlines the steps to release a new version of the React component library by tagging and pushing to GitHub and npm. | ||
|
||
## Prerequisites | ||
|
||
Before proceeding with the release process, ensure that you have the following: | ||
|
||
- Access to the GitHub repository for the component library. | ||
- An npm user account with publishing permissions for the component library. | ||
|
||
## Release Process | ||
|
||
Follow these steps to release a new version: | ||
|
||
1. **Update the version**: Open the `package.json` file and update the version field to the desired version number. Save the changes. | ||
|
||
2. **Commit the changes**: Commit the updated `package.json` file using the following command: | ||
|
||
```shell | ||
git add package.json | ||
git commit -m "Bump version to X.X.X" | ||
``` | ||
|
||
3. **Tag the release**: Create a new Git tag for the release using the following command: | ||
|
||
```shell | ||
git tag -a vX.X.X -m "Release X.X.X" | ||
``` | ||
|
||
Replace `X.X.X` with the actual version number. | ||
|
||
4. **Push the changes**: Push the committed changes and the newly created tag to the GitHub repository: | ||
|
||
```shell | ||
git push origin main | ||
git push origin vX.X.X | ||
``` | ||
|
||
5. **Publish to npm**: Publish the new version to npm using the following command: | ||
|
||
```shell | ||
npm publish | ||
``` | ||
|
||
Note: Make sure you are logged in to the correct npm user account. | ||
|
||
6. **Verify the release**: Visit the GitHub repository and npm package page to verify that the new version has been successfully released. | ||
|
||
## Conclusion | ||
|
||
By following these steps, you can release a new version of tail-react by tagging and pushing to GitHub and npm. | ||
|
||
For any issues or questions, please refer to the project's documentation or seek assistance from the project maintainers. |
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