Skip to content

Commit ed4ff57

Browse files
Add RELEASING.md
1 parent ab8d885 commit ed4ff57

File tree

1 file changed

+43
-0
lines changed

1 file changed

+43
-0
lines changed

RELEASING.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Releasing New Package Version
2+
3+
This document outlines the steps required to release a new version of the package on npm using GitHub Actions for automated publishing.
4+
5+
## Prerequisites
6+
7+
- You have a local clone of the repository.
8+
- Your `package.json` file is properly configured with a unique package name.
9+
- An npm token is added to GitHub Secrets as `NPM_TOKEN`.
10+
- A GitHub Actions workflow file (e.g., `.github/workflows/publish.yml`) is configured to publish the package on tag push.
11+
- All changes are thoroughly tested.
12+
13+
## Step 1: Build and Test the Project
14+
15+
1. **Build the project:**
16+
17+
If your build script is defined as:
18+
19+
`npm run build`
20+
21+
Currently project don't have tests, you can run [examples](./examples) files for make sure that project work correcly.
22+
23+
24+
## Step 2: Update the Package Version
25+
26+
1. **Bump the package version:**
27+
28+
For a patch update, run:
29+
30+
`npm version patch`
31+
32+
or
33+
34+
`npm version minor` / `npm version major` as needed.
35+
36+
This command updates the version in package.json, creates a commit, and generates a new tag (e.g., `v0.0.2`).
37+
38+
2. **Push Changes:**
39+
40+
Execute `git push origin master --tags`
41+
42+
Automated Publishing: The GitHub Actions workflow will automatically build, test, and publish your package to npm.
43+

0 commit comments

Comments
 (0)