Changelog Updater Extension

The Changelog Updater Extension automates the process of updating your project's changelog directly from your source files. Simply type a specially formatted command in your editor, and the extension will handle the rest by incrementing version numbers, adding timestamps, and inserting a new entry into your changelog table.

Features

Automatic Changelog Updates:
Listens for a specific command pattern in your code and automatically updates your changelog.
Version Management:
Supports three types of updates:
- Major (ma): Increments the major version (e.g., 1.2.3 to 2.0.0).
- Minor (mi): Increments the minor version (e.g., 1.2.3 to 1.3.0).
- Patch (pa): Increments the patch version (e.g., 1.2.3 to 1.2.4).
Detailed Logging:
Each entry includes the new version number, the date and time (formatted as YY‑MM‑DD <br> HH:MM), and a description of the change.
Seamless Workflow:
After processing, the original command line is automatically removed, keeping your code clean.

Command Format

To trigger a changelog update, insert a command on its own line using the following format:

cl-<version-type>-<change-type>-<description>--

Components:

version-type:
- ma — Major Update
- mi — Minor Update
- pa — Patch Update
change-type:
Accepted values are: added, changed, deprecated, fixed, removed, secured.
description:
A short summary of the change you’re making.

Examples:

Example 1: Adding a New Security Layer (Minor Update)

Command:

cl-mi-secured-Added new security layer on login.--

After this command is detected, the extension will:

Increment the version (e.g., from 1.0.0 to 1.1.0).
Log the current date and time.
Insert a new entry into the changelog table.

Video Demonstration:

If your markdown viewer does not support embedded videos, click here to watch the demonstration.

Example 2: Fixing a Bug (Patch Update)

Command:

cl-pa-fixed-Login issue and server error on Safari browser.--

After this command is detected, the extension will:

Increment the patch version (e.g., from 1.1.0 to 1.1.1).
Log the current date and time.
Insert a new bug fix entry into the changelog table.

Video Demonstration:

If your markdown viewer does not support embedded videos, click here to watch the demonstration.

How It Works

Detection:
The extension monitors your document for text changes. When it finds a line matching the command pattern, it triggers the update process.
Parsing:
The command is parsed into:
- Version Type: (ma, mi, or pa)
- Change Type: (added, changed, deprecated, fixed, removed, or secured)
- Description: A short explanation of the change.
Changelog Update:
- Retrieves the current version from your changelog (if available) and increments it appropriately.
- Generates a new table row containing the version, timestamp, update type, change type, and description.
- Inserts the new row into your changelog. If the changelog table or header does not exist, it creates them.
Cleanup:
After updating the changelog, the original command line is removed from your document.

Installation

Via the VS Code Marketplace

Open VS Code.
Go to the Extensions view by clicking on the Extensions icon in the Activity Bar.
Search for "Changelog Updater Extension" and click Install.

Manual Installation

Clone this repository.
Open the project folder in VS Code.
Press F5 to launch a new VS Code window with the extension loaded.

Contributing

We welcome your contributions to enhance ALPHANUM! Check out our Contributing Guidelines to get started.

License

How to Contact?

Whether you're a recruiter seeking top talent or a potential client with a project in mind, I'm eager to hear from you. Let's discuss your needs, aspirations, and how I can help bring your vision to life. From exploring job opportunities to collaborating on exciting projects, I'm here to engage in meaningful conversations.

📧 Email: mail@thegenius.one

About DESAIGN STUDIO

Founded in 2011 by Kratu Desai, DESAIGN STUDIO is committed to innovation and excellence in design and technology. Check out our latest projects and see how we bring creativity to life at desaign.studio.

Change-PLOG

Kratu Desai