Import Changelog

The Import Changelog feature in Changeloger allows you to quickly bring existing changelog history into your Release Builder, ensuring a smooth transition for projects migrating from other systems or consolidating release records. With comprehensive parsing capabilities and support for standard changelog formats, this functionality is essential for teams managing detailed product update histories.

Overview of Changelog Import

Importing a changelog lets you populate your Release Builder with release versions, change items, and categories based on a pre-existing text-based changelog. This is ideal if you have maintained changelogs externally, such as in markdown files, plain text, or exported logs from other platforms. Changeloger’s importer systematically parses the provided file, structures releases by version and date, and categorizes changes under Feature, Fix, Improvement, and other configurable types. This keeps your historical data organized and accessible from within the WordPress admin.

Types of Supported Changelog Imports

• Sample Data Import: Quickly add demo releases and example updates to experiment with Changeloger’s features.
• File-based Import: Upload a changelog in supported formats (Markdown or plain text) to convert it into fully structured releases.

How to Import a Changelog

• Step 1: Access Release Builder
  • Go to Changeloger ’ Releases in your WordPress dashboard.
• Step 2: Open the Import Menu
  • Click the Import button, typically located near the releases list.
• Step 3: Choose Import Method
  • For demo data, select Import Sample Data. This will instantly create sample products and releases.
  • To use your own file, select Import from File.
• Step 4: Upload Changelog File
  • Choose your changelog file (plain text or markdown format).
  • Upload the file from your computer.
• Step 5: Review and Confirm
  • Changeloger will parse the file and display a preview of the versions and changes detected.
  • Confirm the import to create releases in your dashboard.

Changelog Format Requirements

To ensure your file is correctly processed, use a consistent format with clear version headers and change type sections. Changeloger recognizes the following standard structure:

## [1.2.0] - 2024-01-15
### Feature
- Added new dashboard widget
- Implemented dark mode support

### Fix
- Fixed login redirect issue
- Resolved mobile menu bug

### Improvement
- Enhanced page load speed

Each version begins with a version header, followed by change types (Feature, Fix, Improvement, etc.), each containing a list of items. Other labels such as Tweaked, Deprecated, Security, and Removed are also supported and will be properly categorized if present.

What Happens After Import

• An individual release is created for every version header detected in your file, complete with release date and version number.
• Change items are assigned to their respective types and included in the release entry.
• You can review, edit, or delete imported releases just like manually created ones.
• For sites with multiple products (Pro feature), releases can be assigned or moved to the correct product as needed.

Benefits of Importing a Changelog

• Save Time: Instantly bring in years of changelog history without manual entry.
• Consistency: Ensure update histories are complete and structured for all users and stakeholders.
• Unified Workflow: Manage both past and future releases within the same interface.
• Public Display: Easily display imported changelogs on your frontend using Release Hub or the Changeloger block.

Troubleshooting Import Issues

• File Not Recognized: Check that your file matches the required format (use standard Markdown or the sample shown above).
• Missing Versions: Ensure a blank line separates each version section in your text file.
• Parsing Errors: Remove any unusual formatting or extra characters that are not part of changelog syntax.

If issues persist, refer to the documentation or reach out to Changeloger support with your changelog file for assistance. Import logs may also provide detailed error messages during the process.

Best Practices for Changelog Import

• Preview changes before you finalize the import—verify that all versions and items appear as expected.
• Backup current releases if you have existing data, in case changes need to be reverted.
• After import, review each release for completeness and clarity, particularly for custom change type labels.

The Import Changelog feature streamlines the onboarding and management process for your product’s development history, providing a robust foundation as you transition to organized, WordPress-based release management.