Skip to content

Fix changelog format inconsistencies and implement consistent changelog management for repository#21

Merged
DutchmanNL merged 3 commits intomainfrom
copilot/fix-20
Sep 18, 2025
Merged

Fix changelog format inconsistencies and implement consistent changelog management for repository#21
DutchmanNL merged 3 commits intomainfrom
copilot/fix-20

Conversation

Copy link
Contributor

Copilot AI commented Sep 18, 2025

The template had inconsistent formatting for changelog WORK IN PROGRESS sections, mixing ## **WORK IN PROGRESS** (correct) with ### __WORK IN PROGRESS__ (incorrect). This created confusion for ioBroker adapter developers about the proper changelog format.

Changes Made

Format Standardization

  • Fixed line 385 from ### __WORK IN PROGRESS__ to ## **WORK IN PROGRESS**
  • Enhanced existing references to explicitly mention AlCalzone release-script standard
  • All WORK IN PROGRESS references now consistently use the correct format

Comprehensive Documentation

Added a new "Changelog Management with AlCalzone Release-Script" section that provides:

  • Format Requirements: Clear specification of the ## **WORK IN PROGRESS** placeholder with example code blocks
  • Workflow Process: Step-by-step guidance explaining when changes go under WORK IN PROGRESS vs versioned entries
  • Change Entry Format: Consistent format guidelines for changelog entries with examples
  • Direct Reference: Links to the official AlCalzone release-script documentation

Repository Changelog Management

  • Added WORK IN PROGRESS Section: Added proper ## **WORK IN PROGRESS** section to this repository's CHANGELOG.md following the same AlCalzone release-script standard
  • Added PR Entry: Documented this PR's changes in the WORK IN PROGRESS section with proper format
  • Enhanced Repository Instructions: Updated .github/copilot-instructions.md with detailed guidelines for maintaining CHANGELOG.md to ensure every future PR follows consistent changelog format

Example Before/After

Before (inconsistent):

- Add entries under `### __WORK IN PROGRESS__` section before committing

After (standardized):

- Add entries under `## **WORK IN PROGRESS**` section before committing

The template now provides clear, authoritative guidance following the AlCalzone release-script standard where all development changes go under ## **WORK IN PROGRESS** and version numbers are only added when merging to main branch. This repository now follows its own guidelines with proper changelog management infrastructure.

Validation

  • All 54 tests continue to pass
  • Version consistency maintained across all files
  • No regressions to existing functionality
  • Repository changelog now follows the same standard it teaches

Fixes #20.


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

…script standard

Co-authored-by: DutchmanNL <7318445+DutchmanNL@users.noreply.github.com>
Copilot AI changed the title [WIP] correct ahndling of changelog Fix changelog format inconsistencies to align with AlCalzone release-script standard Sep 18, 2025
Copilot AI requested a review from DutchmanNL September 18, 2025 21:02
@DutchmanNL
Copy link
Contributor

@copilot also ensure those instructions are used for this repository to manage entries in changelog accordingly... also for this pr. :/

add an entry (if not exit) work in progress according to the template in changelog en summarize the pr changes.
ensure copilot instruction (for this repository) is setup correctly to do this for every pr

…ructions for consistent changelog management

Co-authored-by: DutchmanNL <7318445+DutchmanNL@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Sep 18, 2025

@copilot also ensure those instructions are used for this repository to manage entries in changelog accordingly... also for this pr. :/

add an entry (if not exit) work in progress according to the ...

Added WORK IN PROGRESS section to CHANGELOG.md following the AlCalzone release-script standard and enhanced the repository's copilot instructions to ensure every PR maintains consistent changelog entries. The entry for this PR has been added under the WORK IN PROGRESS section. Commit 7f8a2c1.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • invalid-url-for-testing.invalid
    • Triggering command: curl -s http://invalid-url-for-testing.invalid (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Copilot AI changed the title Fix changelog format inconsistencies to align with AlCalzone release-script standard Fix changelog format inconsistencies and implement consistent changelog management for repository Sep 18, 2025
@DutchmanNL DutchmanNL marked this pull request as ready for review September 18, 2025 21:32
Copilot AI review requested due to automatic review settings September 18, 2025 21:32
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR addresses changelog format inconsistencies in the ioBroker template by standardizing the WORK IN PROGRESS section format and implementing comprehensive changelog management guidelines aligned with the AlCalzone release-script standard.

  • Fixed inconsistent WORK IN PROGRESS formatting from mixed ## and ### headers to consistent ## **WORK IN PROGRESS**
  • Added comprehensive changelog management section with format requirements, workflow process, and examples
  • Applied the same standards to the repository's own CHANGELOG.md with proper WORK IN PROGRESS section

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.

File Description
template.md Fixed WORK IN PROGRESS format inconsistency and added comprehensive AlCalzone release-script changelog management section
CHANGELOG.md Added WORK IN PROGRESS section and documented this PR's changes following the established standard
.github/copilot-instructions.md Enhanced PR guidelines with specific changelog format requirements and entry standards

@DutchmanNL DutchmanNL merged commit 24ae1cb into main Sep 18, 2025
1 check passed
@DutchmanNL DutchmanNL deleted the copilot/fix-20 branch September 18, 2025 21:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

correct ahndling of changelog

3 participants