remove semantic-versioning

Author: bvdmitri

.github/workflows/ci.yml

@@ -5,7 +5,7 @@ on:
   pull_request:
   workflow_dispatch:
 
-# Permissions needed to push to gh-pages and create releases
+# Permissions needed to push to gh-pages
 permissions:
   contents: write
   pages: write
@@ -79,35 +79,6 @@ jobs:
         cd ..
         npm test
 
-  release:
-    needs: [openapi-client-generation, test]
-    if: github.ref == 'refs/heads/main'
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v4
-      with:
-        fetch-depth: 0
-    
-    - name: Set up Node.js
-      uses: actions/setup-node@v4
-      with:
-        node-version: '20.x'
-        cache: 'npm'
-    
-    - name: Install dependencies
-      run: npm ci
-    
-    - name: Configure Git
-      run: |
-        git config --global user.name "GitHub Actions"
-        git config --global user.email "[email protected]"
-    
-    - name: Release
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
-      run: npm run release
-
   docs:
     runs-on: ubuntu-latest
     permissions:

.releaserc.json

@@ -89,34 +89,51 @@ constructor(options?: ClientOptions) {
 1. Have an npm account
 2. Be a member of the @lazydynamics organization
 3. Have the necessary permissions to publish packages
-4. Have a GitHub token with `repo` scope (for semantic-release)
-
-### Publishing Process
-The package uses automated releases through GitHub Actions. When changes are merged into the `main` branch:
-1. The CI pipeline runs tests and verifies the OpenAPI client generation
-2. If all checks pass, semantic-release automatically:
-   - Determines the next version number based on PR titles
-   - Updates package.json
-   - Creates a git tag
-   - Publishes to npm
-   - Creates a GitHub release
 
-### Version Management
-The project uses semantic-release for automated version management. Version numbers are determined by PR titles:
-- `fix:` PRs trigger patch releases (1.0.0 → 1.0.1)
-- `feat:` PRs trigger minor releases (1.0.0 → 1.1.0)
-- PRs with `BREAKING CHANGE:` trigger major releases (1.0.0 → 2.0.0)
+### Publishing Steps
+1. Login to npm:
+   ```bash
+   npm login
+   ```
 
-Example PR titles:
-```
-fix: handle null values in response
-feat: add support for custom headers
-feat: add new API endpoint
+2. Build the package:
+   ```bash
+   npm run build
+   ```
 
-BREAKING CHANGE: remove deprecated method
-```
+3. Update the version in package.json:
+   ```bash
+   npm version <patch|minor|major>
+   ```
+   This will:
+   - Update the version in package.json
+   - Create a git tag
+   - Commit the changes
 
-Note: Releases only happen when changes are merged into the `main` branch. Make sure your PR titles follow the conventional commit format as they determine the version bump.
+4. Push the changes and tag:
+   ```bash
+   git push && git push --tags
+   ```
+
+5. Publish the package:
+   ```bash
+   npm publish
+   ```
+
+6. Create a GitHub release:
+   - Go to the repository's Releases page on GitHub
+   - Click "Create a new release"
+   - Select the tag that was just created
+   - Add release notes describing the changes
+   - Click "Publish release"
+
+Note: After publishing to npm, it's important to create a corresponding GitHub release to maintain consistency between npm and GitHub.
+
+### Version Management
+Use semantic versioning for releases:
+- `npm version patch` for bug fixes (1.0.0 → 1.0.1)
+- `npm version minor` for new features (1.0.0 → 1.1.0)
+- `npm version major` for breaking changes (1.0.0 → 2.0.0)
 
 ## Code Style and Guidelines
 
@@ -131,17 +148,13 @@ Note: Releases only happen when changes are merged into the `main` branch. Make
 1. Create a new branch for your feature/fix
 2. Make your changes
 3. Run tests (when available)
-4. Submit a pull request with a descriptive title following the conventional commit format
-
-### PR Titles
-Follow conventional commits format for PR titles:
-- `feat:` for new features
-- `fix:` for bug fixes
-- `docs:` for documentation changes
-- `style:` for code style changes
-- `refactor:` for code refactoring
-- `test:` for test-related changes
-- `chore:` for maintenance tasks
+4. Submit a pull request
+
+### Commit Messages
+Keep commit messages clear and descriptive:
+- Use present tense
+- Start with a capital letter
+- Be specific about what changed
 
 ## Getting Help
 

CONTRIBUTING.md

@@ -14,8 +14,7 @@
     "docs:serve": "npx serve docs",
     "test": "node scripts/wait-for-server.js && jest",
     "test:watch": "jest --watch",
-    "test:coverage": "jest --coverage",
-    "release": "semantic-release"
+    "test:coverage": "jest --coverage"
   },
   "repository": {
     "type": "git",
@@ -36,13 +35,10 @@
   },
   "devDependencies": {
     "@hey-api/openapi-ts": "^0.66.4",
-    "@semantic-release/git": "^10.0.1",
-    "@semantic-release/github": "^11.0.1",
     "@types/jest": "^29.5.14",
     "@types/node": "^20.11.24",
     "esbuild": "^0.20.2",
     "jest": "^29.7.0",
-    "semantic-release": "^24.2.3",
     "ts-jest": "^29.3.2",
     "typedoc": "^0.28.2",
     "typescript": "^5.3.3"