refactor: exclude example directory from CI/CD pipelines

Author: wataruoguchi

.github/workflows/ci.yml

@@ -4,8 +4,10 @@ on:
   push:
     branches: [main]
     tags: ['v*']
+    paths-ignore: ['example/**']
   pull_request:
     branches: [main]
+    paths-ignore: ['example/**']
 
 jobs:
   test:

.github/workflows/example.yml

@@ -3,6 +3,7 @@ name: Release
 on:
   push:
     tags: ['v*']
+    paths-ignore: ['example/**']
 
 jobs:
   release:

.github/workflows/release.yml

@@ -27,22 +27,22 @@ This guide will help you set up automated testing, building, and publishing for
 
 ## Step 3: Verify GitHub Actions Workflows
 
-The following workflows are already configured:
+The following workflows are configured:
 
 ### `ci.yml` - Continuous Integration
-- **Triggers**: Push to main, pull requests, version tags
+- **Triggers**: Push to main, pull requests, version tags (excludes example directory)
 - **Actions**: Runs tests, linting, and builds
 - **Purpose**: Ensures code quality on every change
 
 ### `release.yml` - Automated Releases
-- **Triggers**: Version tags (e.g., `v1.0.0`)
+- **Triggers**: Version tags (e.g., `v1.0.0`) (excludes example directory)
 - **Actions**: Publishes to npm, creates GitHub release
 - **Purpose**: Automated package publishing
 
-### `example.yml` - Example Build
-- **Triggers**: Changes to example directory
-- **Actions**: Builds the example application
-- **Purpose**: Ensures example code works
+### Important Notes
+- **Example directory changes do NOT trigger pipelines** - The example is for demonstration only
+- **Only changes to the main library code** will trigger CI/CD workflows
+- **Version tags trigger releases** regardless of what files changed
 
 ## Step 4: Test the Setup
 
@@ -115,6 +115,11 @@ git push origin vX.Y.Z
 - Verify all dependencies are installed
 - Check for missing files in the build
 
+**"Pipeline not triggering"**
+- Ensure you're not only changing files in the `example/` directory
+- Check that your changes are in the `lib/` directory or root files
+- Verify you're pushing to the main branch
+
 ### Getting Help
 
 1. Check the GitHub Actions logs for detailed error messages
@@ -129,6 +134,7 @@ git push origin vX.Y.Z
 3. **Write good commit messages** for better release notes
 4. **Review the generated release notes** before publishing
 5. **Test the published package** in a new project
+6. **Keep example changes separate** from library changes
 
 ## Security Notes
 

docs/CI-CD-SETUP.md

@@ -264,9 +264,14 @@ This project uses GitHub Actions for continuous integration and deployment:
 
 ### Workflows
 
-- **CI/CD** (`ci.yml`): Runs tests and linting on every push/PR
+- **CI/CD** (`ci.yml`): Runs tests and linting on every push/PR (excludes example directory)
 - **Release** (`release.yml`): Publishes to npm and creates GitHub releases on version tags
-- **Example Build** (`example.yml`): Ensures the example application builds correctly
+
+### Important Notes
+
+- **Example directory changes do NOT trigger pipelines** - The example is for demonstration only
+- **Only changes to the main library code** will trigger CI/CD workflows
+- **Version tags trigger releases** regardless of what files changed
 
 ### Release Process