How to Use Conventional Commits with Semantic Versioning

steps

1. Initialize a new Git repository:
   bashCopy

   git init

2. Add your project files:
   bashCopy

   git add .

3. Commit your files:
   bashCopy

   git commit -m "Initial commit"

steps

1. Use standard headers like feat, fix, or chore:
   • Example for a new feature:
     bashCopy

     git commit -m "feat: add user authentication module"

   • Example for a bug fix:
     bashCopy

     git commit -m "fix: resolve issue with login timeout"

2. Include a BREAKING CHANGE footer for significant updates affecting the API or behavior:
   bashCopy

   BREAKING CHANGE: refactor API to use GraphQL

3. Maintain a clear structure:
   • Header: <type>(optional scope): <description>
   • Body: (optional) Additional context.
   • Footer: (optional) Breaking changes or references to issues.

steps

1. MAJOR: Introduce breaking changes, noted by BREAKING CHANGE.
2. MINOR: Add features without breaking existing functionality (feat commits).
3. PATCH: Fix bugs or small tweaks (fix commits).
4. Ensure your team adheres to these guidelines for consistent version histories.

steps

1. Install the required package:
   bashCopy

   npm install semantic-release --save-dev

2. Create a .releaserc.json file in your project directory with basic configuration:
   jsonCopy

   {
     "branches": ["main"],
     "plugins": [
       "@semantic-release/commit-analyzer",
       "@semantic-release/release-notes-generator",
       "@semantic-release/npm",
       "@semantic-release/github"
     ]
   }

3. Integrate semantic-release into your CI/CD workflow. For example, in GitHub Actions, add a job to your .github/workflows/release.yml:
   yamlCopy

   name: Release
   
   on:
     push:
       branches:
         - main
   
   jobs:
     release:
       runs-on: ubuntu-latest
       steps:
         - uses: actions/checkout@v3
         - uses: actions/setup-node@v3
           with:
             node-version: '18'
         - run: npm ci
         - run: npx semantic-release