@@ -27,34 +27,21 @@ The testing workflow runs automatically:
2727- Weekly on Monday at midnight UTC
2828
2929The workflow includes:
30- 1 . Unit tests - Run across multiple Node.js versions (18.x, 20.x)
30+ 1 . Unit tests - Run across multiple Node.js versions
31312 . Integration tests - Run on Node.js 20.x using provided API secrets
3232
33- ### Setting up API keys for CI
33+ ## Release Process (Maintainers)
3434
35- To enable integration tests in CI, add your API keys as secrets in your GitHub repository:
36-
37- 1 . Go to your GitHub repository
38- 2 . Click on "Settings" > "Secrets and variables" > "Actions"
39- 3 . Add the following secrets:
40- - ` OPENAI_API_KEY ` - Your OpenAI API key
41- - ` GOOGLE_API_KEY ` - Your Google API key
35+ This project uses semantic versioning. To create a new release:
4236
43- ## Release Process
37+ ``` bash
38+ npm version patch # or minor, or major
39+ git push origin main --tags
40+ ```
4441
45- This project uses semantic versioning. To create a new release:
42+ ` npm version ` automatically bumps the version in ` package.json ` and ` package-lock.json ` , creates a commit, and creates a git tag.
4643
47- 1 . Update the version in ` package.json `
48- 2 . Update the ` CHANGELOG.md ` with details of the changes
49- 3 . Commit these changes with a message like "Bump version to x.y.z"
50- 4 . Create and push a new tag:
51- ```
52- git tag -a vx.y.z -m "Release version x.y.z"
53- git push origin vx.y.z
54- ```
55-
56- When you push a new tag prefixed with "v" (e.g., v1.0.0), GitHub Actions will automatically:
57- 1 . Build the package
58- 2 . Run unit tests
59- 3 . Create a GitHub Release with notes from your git history
60- 4 . Publish the package to npm
44+ When the tag is pushed, GitHub Actions will automatically:
45+ 1 . Build the package and run tests
46+ 2 . Create a GitHub Release with notes generated from git history
47+ 3 . Publish the package to npm
0 commit comments