update auto publish

Author: mohab-sameh

.github/workflows/auto-publish.yml

@@ -11,6 +11,7 @@ on:
 jobs:
   auto-publish:
     runs-on: ubuntu-latest
+    environment: production
 
     steps:
     - name: Checkout code

AUTO_PUBLISH_SETUP.md

@@ -1,39 +1,40 @@
 # Auto-Publishing Setup
 
-This repository includes two auto-publishing workflows for different use cases:
-
-1. **Direct Auto-Publish**: Automatically publishes when changes are pushed to `main`
-2. **PR-based Auto-Publish**: Detects changes in PRs and waits for maintainer approval
-
-Both workflows publish codemods from the `recipes/` directory to the Codemod Registry.
+This repository includes an auto-publishing workflow that automatically publishes codemods to the Codemod Registry when changes are merged to `main`.
 
 ## Quick Setup
 
 1. **Get API key**: [https://app.codemod.com/api-keys](https://app.codemod.com/api-keys)
-2. **Run setup script**:
-   ```bash
-   ./scripts/setup-auto-publish.sh
-   ```
-
-The script will ask for your API key, registry scope (e.g., `your-org`), and registry URL.
+2. **Create GitHub Environment** (required for secrets):
+   - Go to your repository → Settings → Environments
+   - Click "New environment"
+   - Name it `production` (or any name you prefer)
+   - Click "Configure environment"
+3. **Add secrets to the environment**:
+   - In the environment settings, add these secrets:
+     - `CODEMOD_API_KEY`: Your API key from step 1
+   - Optionally add these variables:
+     - `CODEMOD_REGISTRY_SCOPE`: Your organization scope (e.g., `your-org`)
+     - `CODEMOD_REGISTRY_URL`: Registry URL (defaults to `https://registry.codemod.com`)
 
 ## How It Works
 
-### Direct Auto-Publish (Default)
+### Auto-Publish Workflow
 - **Trigger**: Push to `main` branch
-- **Process**: Automatically detects changes and publishes
-- **Best for**: Solo maintainers or trusted teams
+- **Process**: 
+  1. Automatically detects changes in `recipes/` directory
+  2. Publishes new/updated codemods to the registry
+  3. Unpublishes removed codemods
+  4. Auto-resolves version conflicts (bumps patch version)
 
-### PR-based Auto-Publish (Recommended for Open Source)
+### PR Detection Workflow
 - **Trigger**: Pull request with codemod changes
 - **Process**: 
   1. Bot detects changed codemods in PR
-  2. Posts comment with pre-filled publish commands
-  3. Waits for maintainer approval (thumbs up reaction)
-  4. Executes publishing commands when approved
-- **Best for**: Open source projects with community contributions
+  2. Posts comment: "Codemods will be auto-published on merge to main"
+  3. No action required - just merge the PR
 
-### Common Features
+### Features
 - **New codemods**: Published for the first time
 - **Updated codemods**: Version bumped and republished  
 - **Removed codemods**: Automatically unpublished
@@ -51,40 +52,32 @@ The script will ask for your API key, registry scope (e.g., `your-org`), and reg
 - Never exposed in code, logs, or documentation
 - Only GitHub Actions can access the key
 
-## Manual Setup
-
-If you prefer manual setup:
-
-1. **GitHub Secrets**: `CODEMOD_API_KEY` (your API key)
-2. **GitHub Variables**: 
-   - `CODEMOD_REGISTRY_SCOPE` (your organization scope)
-   - `CODEMOD_REGISTRY_URL` (registry URL, optional)
-
 ## Examples
 
-### Direct Auto-Publish
+### Auto-Publish on Merge
 ```bash
-# 1. Make changes
+# 1. Make changes to codemod
 echo "console.log('test');" > recipes/my-codemod/tests/input.js
 
-# 2. Commit and push
+# 2. Create PR
 git add recipes/my-codemod/
 git commit -m "Add test case"
+git push origin feature-branch
+# Create PR on GitHub
+
+# 3. Bot comments: "Codemods will be auto-published on merge to main"
+
+# 4. Merge PR to main
+git checkout main
+git merge feature-branch
 git push origin main
 
-# 3. GitHub Actions automatically publishes to registry
-# 4. Available at: https://registry.codemod.com/@your-scope/my-codemod
+# 5. GitHub Actions automatically publishes to registry
+# 6. Available at: https://registry.codemod.com/@your-scope/my-codemod
 ```
 
-### PR-based Auto-Publish
-```bash
-# 1. Community contributor opens PR with codemod changes
-# 2. Bot automatically posts comment:
-#    "Show a thumbs up to this comment and I'll run:
-#     git tag -a v1.0.0@my-codemod -m 'Release version v1.0.0 for my-codemod'
-#     git push origin --tags"
-
-# 3. Maintainer reviews and gives thumbs up 👍
-# 4. Bot executes commands and updates comment with success
-# 5. Codemod is published to registry
-```
+### Environment Setup Screenshots
+1. **Repository Settings** → **Environments** → **New environment**
+2. **Name**: `production` → **Configure environment**
+3. **Add secrets**: `CODEMOD_API_KEY` with your API key
+4. **Add variables** (optional): `CODEMOD_REGISTRY_SCOPE`, `CODEMOD_REGISTRY_URL`

README.md

@@ -30,12 +30,12 @@ This template repository comes pre-configured with a GitHub workflow that automa
 > 
 > 6. Set up auto-publishing to [Codemod Registry](https://app.codemod.com/registry):
 > 
-> ```bash
-> # Get API key from https://app.codemod.com/api-keys
-> ./scripts/setup-auto-publish.sh
-> ```
+> 1. **Get API key**: [https://app.codemod.com/api-keys](https://app.codemod.com/api-keys)
+> 2. **Create GitHub Environment**: Repository Settings → Environments → New environment (name it `production`)
+> 3. **Add secret**: `CODEMOD_API_KEY` with your API key
+> 4. **Optional variables**: `CODEMOD_REGISTRY_SCOPE`, `CODEMOD_REGISTRY_URL`
 > 
-> This automatically publishes codemods when you push changes to `recipes/`. See [AUTO_PUBLISH_SETUP.md](./AUTO_PUBLISH_SETUP.md) for details.
+> This automatically publishes codemods when you merge changes to `main`. See [AUTO_PUBLISH_SETUP.md](./AUTO_PUBLISH_SETUP.md) for details.
 
 
 ## Overview