diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8b2524d..fc3cfc8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -27,34 +27,21 @@ The testing workflow runs automatically: - Weekly on Monday at midnight UTC The workflow includes: -1. Unit tests - Run across multiple Node.js versions (18.x, 20.x) +1. Unit tests - Run across multiple Node.js versions 2. Integration tests - Run on Node.js 20.x using provided API secrets -### Setting up API keys for CI +## Release Process (Maintainers) -To enable integration tests in CI, add your API keys as secrets in your GitHub repository: - -1. Go to your GitHub repository -2. Click on "Settings" > "Secrets and variables" > "Actions" -3. Add the following secrets: - - `OPENAI_API_KEY` - Your OpenAI API key - - `GOOGLE_API_KEY` - Your Google API key +This project uses semantic versioning. To create a new release: -## Release Process +```bash +npm version patch # or minor, or major +git push origin main --tags +``` -This project uses semantic versioning. To create a new release: +`npm version` automatically bumps the version in `package.json` and `package-lock.json`, creates a commit, and creates a git tag. -1. Update the version in `package.json` -2. Update the `CHANGELOG.md` with details of the changes -3. Commit these changes with a message like "Bump version to x.y.z" -4. Create and push a new tag: - ``` - git tag -a vx.y.z -m "Release version x.y.z" - git push origin vx.y.z - ``` - -When you push a new tag prefixed with "v" (e.g., v1.0.0), GitHub Actions will automatically: -1. Build the package -2. Run unit tests -3. Create a GitHub Release with notes from your git history -4. Publish the package to npm +When the tag is pushed, GitHub Actions will automatically: +1. Build the package and run tests +2. Create a GitHub Release with notes generated from git history +3. Publish the package to npm