Weave Code
Jetpack Changelogger Laravel Package
automattic/jetpack-changelogger
Automattic’s Jetpack Changelogger helps you create and manage changelog entries with a simple workflow, keeping releases consistent across projects. Designed for Jetpack development, it streamlines collecting notes and generating clean, structured changelogs.
[READ ONLY] Allows for managing changelogs by dropping change files into a changelog directory with each PR. This repository is a mirror, for issue tracking and development head to: https://github.com/automattic/jetpack
Frequently asked questions about Jetpack Changelogger
- How do I install automattic/jetpack-changelogger in a Laravel project?
- Run `composer require automattic/jetpack-changelogger` in your project directory. The package is lightweight and doesn’t require additional setup beyond configuring the changelog directory path, typically in `config/changelogger.php` or via a service provider. No database migrations or complex dependencies are involved.
- Does this package work with Laravel 10+? What’s the version support?
- The package is designed for modern Laravel versions and should work with Laravel 8 through 10, as it relies on basic filesystem operations and no Laravel-specific features. However, since it’s a mirror of Automattic’s Jetpack tool, check the original repository for updates, as maintenance may be limited.
- Can I generate changelogs automatically from Git commits instead of manual file drops?
- No, this package is read-only and requires manual changelog file drops (e.g., via PRs). To automate generation, you’d need a custom Artisan command or script that parses Git logs and writes to the configured directory. The package doesn’t provide hooks or events for this.
- How do I configure the changelog directory path in Laravel?
- Use a Laravel service provider to bind the changelog directory path, typically in `config/changelogger.php` or via `config(['changelogger.path' => storage_path('app/changelog')])`. The package expects a writable directory, so ensure permissions are set (e.g., `chmod -R 775 storage/app/changelog`).
- Will this work in shared hosting environments with restricted filesystem access?
- Potential issues may arise if the `storage/app/changelog` directory lacks write permissions, which is common in shared hosting. Test the directory permissions early, and consider using Laravel’s `storage:link` or a cloud storage adapter (e.g., S3) if local filesystem access is unreliable.
- Can I sync changelogs across multiple environments (dev, staging, prod)?
- Since changelogs are stored as files, you’ll need to manually sync them or use Laravel’s filesystem drivers (e.g., S3, FTP) to share the directory across environments. For automated syncs, integrate with a backup tool like `spatie/laravel-backup` or use a shared storage solution like a network drive.
- Are there alternatives to this package for Laravel changelog management?
- Yes. For database-backed changelogs, consider `spatie/laravel-activitylog`. For Git-based solutions, use `keepachangelog` (manual) or tools like `laravel-release`. If you need PR-driven automation, explore GitHub Actions or custom scripts that parse commit messages and generate changelogs programmatically.
- How do I handle merge conflicts if multiple changelog files are added simultaneously?
- The package doesn’t include conflict resolution logic, so you’ll need to implement it manually. Use a naming convention (e.g., timestamped files) or a merge tool like `git merge-file` to combine changelog entries. Alternatively, enforce a single changelog file per PR and merge them sequentially.
- Does this package support custom changelog templates or Markdown formatting?
- No, the package is read-only and doesn’t support templating or formatting. Changelog files must be manually formatted (e.g., Markdown) before being dropped into the directory. For dynamic templates, you’d need to pre-process files with a script or use a different tool like `spatie/laravel-markdown`.
- Is there a way to trigger changelog generation via GitHub webhooks or Laravel events?
- No, the package doesn’t support webhooks or Laravel events. To automate changelog generation, you’d need to create a custom listener (e.g., for `repository.pushed` events) or a GitHub Actions workflow that writes changelog files on PR merge. This requires additional setup beyond the package’s core functionality.
Weaver
How can I help you explore Laravel packages today?