Cursor rule

1# CI/CD Workflow Standards
2 
3## GitHub Actions Pipeline
4The main workflow is in `.github/workflows/build.yml` with three stages:
5 
6### Build Stage
7- Runs on every push and pull request
8- Uses Java 21 and Ubuntu 24.04
9- Builds the mod using Gradle
10- Uploads artifacts for later stages
11 
12### Documentation Stage
13- Builds Docusaurus documentation site
14- Deploys to GitHub Pages on main branch
15- Uses Node.js 18 for build process
16 
17### Release Stage
18- Triggers only on tag creation
19- Generates dynamic changelog from Git history
20- Creates GitHub release with artifacts
21- Publishes to Modrinth automatically
22 
23## Key Features
24- **Dynamic Changelog**: Generated from Git commit history
25- **Multi-Platform Publishing**: GitHub Releases + Modrinth (optional)
26- **Staged Pipeline**: Build → Docs → Release dependencies
27- **Tag-Based Releases**: Only publishes when tags are created
28- **Automated Testing**: Runs tests on every push/PR
29 
30## Environment Variables (GitHub Secrets)
31- `MODRINTH_TOKEN` - For Modrinth publishing (optional)
32- `PROJECT_ID` - Modrinth project identifier (optional)
33- `GITHUB_TOKEN` - For GitHub releases (auto-provided)
34- Additional secrets can be configured as needed
35 
36## Release Process
371. Update version in `gradle.properties`
382. Commit changes: `git commit -m "Release version X.Y.Z"`
393. Create and push a tag: `git tag X.Y.Z && git push origin X.Y.Z`
404. Pipeline automatically:
41   - Builds the mod
42   - Runs tests
43   - Generates changelog from commit history
44   - Creates GitHub release with artifacts
45   - Publishes to Modrinth (if configured)
46   - Updates documentation site
47 
48## Important Notes
49- Use Ubuntu 24.04 for consistency
50- Java 21 is required for modern Minecraft versions
51- Documentation site uses Docusaurus v3
52- Pipeline uses latest GitHub Actions (v4)
53- Supports both Windows and Linux development
54- Consider adding platform-specific tests
55description:
56globs:
57alwaysApply: false
58---
59