Skip to content

Conversation

@sfreudenthaler
Copy link
Member

🎯 Production Best Practices Update

This PR updates all documentation and examples to emphasize using version tags instead of for production stability.

✅ Changes Made

  • README.md: Updated migration checklist to emphasize using instead of
  • Migration Guide: Added section explaining why version tags matter for production
  • All Example Files: Updated to use instead of
  • Documentation: Added warnings about production stability

🚨 Why This Matters

Using in production can cause:

  • Unexpected behavior when main branch is updated
  • Breaking changes affecting production workflows
  • Difficulty in rollback scenarios
  • Inconsistent behavior across deployments

📋 Migration Checklist Updated

The migration checklist now includes:

  1. ✅ Remove references to the old pilot workflow
  2. ✅ Update workflow to use orchestrator with version tags ()
  3. ⚠️ Important: Always use version tags for production stability
  4. ✅ Configure secret
  5. ✅ Test migration with sample PR

🔗 Files Updated

    • Migration checklist and examples
    • Version tag best practices
    • Updated to
    • Updated to
    • Updated to

This ensures all teams migrating to the centralized workflows will follow production best practices from day one.

- Update README.md migration checklist to emphasize using @v1.0.0
- Add warning about production stability with version tags
- Update all example files to use @v1.0.0 instead of @main
- Add section in migration guide about version tag importance
- Ensure all documentation promotes production best practices
@sfreudenthaler sfreudenthaler requested review from a team as code owners July 8, 2025 00:30
@sfreudenthaler sfreudenthaler merged commit c5f29f1 into main Jul 8, 2025
3 checks passed
@sfreudenthaler sfreudenthaler deleted the docs/version-tags-best-practices branch July 8, 2025 00:35
dcolina added a commit that referenced this pull request Dec 16, 2025
Root cause: /tmp directory is NOT cleaned between jobs in GitHub Actions,
causing temp files to persist and contaminate subsequent workflow runs.

This caused two critical bugs:
- Bug #1: /tmp/validation_failed.txt persisted from previous runs, causing
  valid PRs to fail with exit code 1
- Bug #2: /tmp/new_images.txt and /tmp/old_images.txt accumulated data
  from multiple test PRs, causing wrong images to be processed

Solution: Add explicit cleanup at the start of each step that uses temp files.

Changes:
1. validate-changed-files: Clean /tmp/disallowed_files.txt
2. validate-image-only-changed: Clean /tmp/validation_failed.txt,
   /tmp/new_images.txt, /tmp/old_images.txt
3. validate-images: Clean /tmp/validation_failed.txt

Fixes: Bug #1 - Exit code 1 on successful validations
Fixes: Bug #2 - Wrong image processed (Test Case #6)
Related: Test Cases #1, #2, #6
dcolina added a commit that referenced this pull request Dec 16, 2025
## Bug Fixes: Temp File Cleanup (Bug #1 and Bug #2)

Fixes critical bugs by adding explicit cleanup of temp files at the
start of each job.

**Root Cause:** /tmp directory persists between jobs in GitHub Actions.

**Bugs Fixed:**
- Bug #1: Exit code 1 on successful validations (Test Cases #1, #2)
- Bug #2: Wrong image processed (Test Case #6)

**Solution:** Add `rm -f` cleanup at start of each step using temp
files.

---
Will recreate tag v1.1.1 after merge to avoid changing caller workflows.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant