Add automated production release workflow with Crowdin integration, automatic versioning, and GitHub releases

[Copilot]

GitHub Action for Production Release Workflow

This PR adds a GitHub Action workflow that triggers on merge to master to create production-ready releases with automatic versioning and GitHub release creation.

Plan:

• Create .github/workflows/release.yml workflow file
• Add Crowdin translation download step (using Crowdin GitHub Action)
• Add Node.js setup and build step (yarn install --frozen-lockfile && yarn build)
• Add PHP/Composer setup and production install step (composer install --no-dev --optimize-autoloader)
• Add cleanup steps (remove node_modules and minimize vendor)
• Add archive creation step (zip the project for release)
• Add release artifact upload
• Create comprehensive README documentation
• Optimize workflow based on code review (combined find commands, removed unused code)
• Validate YAML syntax and structure
• Address final code review feedback (remove redundant parameters, update docs)
• Fix CodeQL security issue (add explicit permissions)
• Implement user feedback from PR review
  • Use composer-vendor-cleaner package for vendor optimization
  • Add workflow validation steps and echoes
  • Add checksum generation (SHA256 and MD5)
  • Configure Crowdin to output to resources/lang/ with PHP files
  • Optimize yarn installation for production
  • Update PHP to 8.4
  • Add required PHP extensions (gd, bcmath, dom, intl, xml, zip)
  • Add .DS_Store cleanup
  • Add mPDF optimization (fonts and QR code data)
  • Add release notes generation
• Address automated code review feedback
  • Optimize vendor cleaner installation process
  • Improve mPDF cleanup readability
  • Limit release notes to prevent performance issues
• Update Crowdin config to use full language names
• Add automatic versioning and GitHub release creation
  • Shallow clone with tags (fetch-depth: 1)
  • Configurable release type (alpha/beta/stable)
  • Automatic version tagging
  • Release notes between tags
  • GitHub Release creation in Releases section
• All validation complete ✅

What's Included:

New Files:

• .github/workflows/release.yml - Production release workflow (314 lines, fully optimized)
• .github/workflows/README.md - Comprehensive documentation (updated)
• crowdin.yml - Crowdin configuration for Laravel PHP translations

Workflow Features:

1. Crowdin Integration - Downloads latest translations to resources/lang/ with PHP files
2. Translation Validation - Validates language directory structure
3. Frontend Build - Compiles production assets with Vite (optimized yarn installation)
4. Backend Dependencies - Installs production PHP dependencies only
5. Vendor Optimization - Uses composer-vendor-cleaner package + custom cleanup
6. mPDF Optimization - Removes unnecessary fonts (keeps DejaVu) and QR code data
7. Packaging - Creates timestamped ZIP archive with -9 compression
8. Checksums - Generates SHA256 and MD5 checksums
9. Automatic Versioning - Creates version tags based on configurable release type
10. Release Notes - Generates changelog between git tags
11. GitHub Releases - Automatically creates releases in the Releases section
12. Artifact Storage - Uploads ZIP, checksums, and release notes (90-day retention)
13. Security - Minimal permissions (contents: write, actions: write)

Enhanced Workflow Steps (16 total):

1. ✅ Checkout repository (shallow clone with tags for performance)
2. ✅ Download translations from Crowdin (configured for resources/lang/)
3. ✅ Validate translations directory structure
4. ✅ Setup Node.js with caching
5. ✅ Install frontend dependencies (production optimized)
6. ✅ Build frontend assets
7. ✅ Setup PHP 8.4 with all required extensions
8. ✅ Display tool versions (PHP, Composer, Node, npm, Yarn)
9. ✅ Install Composer dependencies (production)
10. ✅ Install and run composer-vendor-cleaner (optimized)
11. ✅ Clean workspace (node_modules, .DS_Store, mPDF, .git, .github)
12. ✅ Package InvoicePlane with checksums
13. ✅ Generate version tag and release notes (between tags)
14. ✅ Upload release artifact
15. ✅ Create GitHub Release (automatic)
16. ✅ Display workflow summary

Automatic Versioning & Releases:

Release Types (configurable via RELEASE_TYPE environment variable):

• alpha - Pre-release versions (increments patch, adds -alpha suffix: v0.1.1-alpha)
• beta - Beta versions (increments patch, adds -beta suffix: v0.1.1-beta)
• stable - Stable releases (increments minor version: v0.2.0)

Versioning Strategy:

• Detects latest tag (or starts from v0.0.0)
• Automatically increments version based on release type
• Creates and pushes new git tag
• Generates release notes showing changes between tags

GitHub Releases:

• Automatically created in the Releases section
• Pre-release flag for alpha/beta versions
• Includes ZIP file, SHA256/MD5 checksums, and release notes
• Tagged with version number

PHP Configuration:

• Version: 8.4
• Extensions: gd, bcmath, dom, intl, xml, zip, mbstring, pdo_mysql
• mPDF Support: Optimized for PDF generation

Crowdin Configuration:

• Language Format: Full language names (e.g., "english", "german", "french")
• Translation Path: resources/lang/%language%/**/*.php
• Preserves: Laravel translation structure with PHP files

Latest Optimizations:

• Checkout: Shallow clone (fetch-depth: 1) with tags for faster performance
• Vendor Cleaner: Uses --no-update for faster installation
• mPDF Cleanup: More readable and explicit find command
• Release Notes: Generated between git tags (previous tag to HEAD)
• Crowdin: Updated to use %language% placeholder for full language names
• Permissions: Updated to contents: write for creating releases and tags

Required Setup:

The workflow requires two GitHub secrets to be configured:

• CROWDIN_PROJECT_ID - Your Crowdin project ID
• CROWDIN_PERSONAL_TOKEN - Your Crowdin personal access token

Artifacts Created:

Each workflow run produces:

GitHub Release (primary delivery method):

• Release tagged with version (e.g., v0.1.0-alpha)
• ZIP file attached to release
• SHA256 and MD5 checksums attached
• Release notes with changelog between tags

Workflow Artifacts (90-day retention):

• invoiceplane-v2-YYYYMMDD_HHMMSS.zip - Production package
• sha256.txt - SHA256 checksum
• md5.txt - MD5 checksum
• RELEASE_NOTES.md - Changelog

Requirements Addressed:

✅ 1. Retrieve translations from Crowdin (to resources/lang/ with PHP files, full language names)
✅ 2. Build frontend assets for production (optimized yarn install)
✅ 3. Install PHP dependencies without dev requirements
✅ 4. Clean up node_modules directory
✅ 5. Minimize vendor directory (composer-vendor-cleaner + custom cleanup)
✅ 6. Create zip archive for release (with checksums and release notes)
✅ 7. Fetch only last commit (shallow clone with tags for performance)
✅ 8. Tag new release (configurable: alpha/beta/stable in workflow env variable)
✅ 9. Release notes between tags (automatic changelog generation)
✅ 10. Create GitHub Release (automatic publication to Releases section)

Additional Enhancements from User Feedback:

✅ composer-vendor-cleaner integration (optimized installation)
✅ Validation steps with clear output
✅ Checksum generation (SHA256 + MD5)
✅ Release notes generation (between tags)
✅ PHP 8.4 support
✅ Extended PHP extensions for mPDF
✅ .DS_Store cleanup
✅ mPDF optimization (improved readability)
✅ Workflow progress echoes
✅ Crowdin configured for full language names
✅ Automatic versioning and tagging
✅ GitHub Release creation
✅ Shallow clone for performance
✅ Configurable release type

Testing & Validation:

✅ YAML syntax validated
✅ Workflow structure verified
✅ User feedback implemented
✅ Automated code review feedback addressed
✅ CodeQL security scan passed
✅ No security vulnerabilities detected

Original prompt

Every time i merge to master i nedd a GitHub action that: 1) retrieves the translaions from crowdin, 2) yarn install --frozen-lockfile && yarn build (for production), 3) composer install (without require-dev), 4) rm -Rf node_modules, 5) clean the "vendor" directory, so it's as small as possible, 5) zip the project, so it can be released

---

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

[nielsdrost7]

@copilot my translation languages don't have "two letters", they are the full language names

[Copilot]

Updated in commit d104ccc. Changed the Crowdin configuration to use %language% placeholder instead of %two_letters_code%. This will now use full language names (e.g., "english", "german", "french") for the directory structure in resources/lang/.

[coderabbitai]

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Note

Other AI code review bot(s) detected

CodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review.

Tip

📝 Customizable high-level summaries are now available in beta!

You can now customize how CodeRabbit generates the high-level summary in your pull requests — including its content, structure, tone, and formatting.

• Provide your own instructions using the high_level_summary_instructions setting.
• Format the summary however you like (bullet lists, tables, multi-section layouts, contributor stats, etc.).
• Use high_level_summary_in_walkthrough to move the summary from the description to the walkthrough section.

Example instruction:

"Divide the high-level summary into five sections:

1. 📝 Description — Summarize the main change in 50–60 words, explaining what was done.
2. 📓 References — List relevant issues, discussions, documentation, or related PRs.
3. 📦 Dependencies & Requirements — Mention any new/updated dependencies, environment variable changes, or configuration updates.
4. 📊 Contributor Summary — Include a Markdown table showing contributions:
   | Contributor | Lines Added | Lines Removed | Files Changed |
5. ✔️ Additional Notes — Add any extra reviewer context.
   Keep each section concise (under 200 words) and use bullet or numbered lists for clarity."

Note: This feature is currently in beta for Pro-tier users, and pricing will be announced later.

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}