feat: implement fork-friendly CI/CD with opt-in mechanism (#476)
- CI/CD disabled by default in forks to conserve resources - Users can enable via ENABLE_CI_IN_FORK repository variable - Added comprehensive Fork Guide documentation - Updated README with Contributing section - Created automation script for future implementations Benefits: - Saves GitHub Actions minutes across 1,600+ forks - Cleaner fork experience for contributors - Full control for fork owners - PR validation still runs automatically BREAKING CHANGE: CI/CD no longer runs automatically in forks. Fork owners must set ENABLE_CI_IN_FORK=true to enable workflows. Co-authored-by: Brian <bmadcode@gmail.com> Co-authored-by: PinkyD <paulbeanjr@gmail.com>
This commit is contained in:
20
README.md
20
README.md
@@ -212,6 +212,26 @@ The generated XML file contains your project's text-based source files in a stru
|
||||
|
||||
📋 **[Read CONTRIBUTING.md](CONTRIBUTING.md)** - Complete guide to contributing, including guidelines, process, and requirements
|
||||
|
||||
### Working with Forks
|
||||
|
||||
When you fork this repository, CI/CD workflows are **disabled by default** to save resources. This is intentional and helps keep your fork clean.
|
||||
|
||||
#### Need CI/CD in Your Fork?
|
||||
|
||||
See our [Fork CI/CD Guide](.github/FORK_GUIDE.md) for instructions on enabling workflows in your fork.
|
||||
|
||||
#### Contributing Workflow
|
||||
|
||||
1. **Fork the repository** - Click the Fork button on GitHub
|
||||
2. **Clone your fork** - `git clone https://github.com/YOUR-USERNAME/BMAD-METHOD.git`
|
||||
3. **Create a feature branch** - `git checkout -b feature/amazing-feature`
|
||||
4. **Make your changes** - Test locally with `npm test`
|
||||
5. **Commit your changes** - `git commit -m 'feat: add amazing feature'`
|
||||
6. **Push to your fork** - `git push origin feature/amazing-feature`
|
||||
7. **Open a Pull Request** - CI/CD will run automatically on the PR
|
||||
|
||||
Your contributions are tested when you submit a PR - no need to enable CI in your fork!
|
||||
|
||||
## License
|
||||
|
||||
MIT License - see [LICENSE](LICENSE) for details.
|
||||
|
||||
Reference in New Issue
Block a user