Skip to content

Fix GitHub version badge and simplify Quick Start section#31

Merged
DutchmanNL merged 4 commits intomainfrom
copilot/fix-28
Sep 19, 2025
Merged

Fix GitHub version badge and simplify Quick Start section#31
DutchmanNL merged 4 commits intomainfrom
copilot/fix-28

Conversation

Copy link
Contributor

Copilot AI commented Sep 19, 2025

This PR resolves the issue with the non-functional GitHub version badge and streamlines the Quick Start section as requested.

Problem

The GitHub version badge ![Version](https://img.shields.io/github/package-json/v/DrozmotiX/ioBroker-Copilot-Instructions?label=Current%20Version) was not working because the repository lacked a package.json file. Additionally, the Quick Start section contained redundant information that could be simplified.

Solution

1. GitHub Version Badge Fix

  • Created a comprehensive package.json file with version 0.4.0 and proper metadata
  • Integrated package.json into the existing dynamic version management system
  • Enhanced scripts/manage-versions.sh to automatically maintain package.json during version updates

2. Version Management System Enhancement

The version management system now fully supports package.json:

  • show command displays package.json version alongside other version files
  • update command automatically updates package.json version
  • check command validates package.json version consistency with other files
  • All existing functionality preserved while adding package.json support

3. Quick Start Section Simplification

Streamlined the Quick Start section by removing verbose instructions (lines 30-45) and keeping only the essential version badges and documentation links, making it more concise and focused.

4. Comprehensive Testing

Added 5 new test cases to ensure robust package.json version management:

  • Package.json version display verification
  • Inconsistency detection when package.json version differs
  • Version update functionality validation
  • File content verification after updates
  • Integration with existing version management workflows

Verification

All 54+ automated tests pass, including the new package.json functionality. The version management system correctly handles updates across all files (template.md, README.md, package.json, .github/copilot-instructions.md) maintaining consistency.

The GitHub version badge will display correctly once shields.io refreshes its cache with the newly available package.json file.

Fixes #28.

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:

  • img.shields.io
    • Triggering command: curl -s -I REDACTED (dns block)
    • Triggering command: curl -s --connect-timeout 10 REDACTED (dns block)

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


💡 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.

Copilot AI and others added 2 commits September 19, 2025 00:51
Co-authored-by: DutchmanNL <7318445+DutchmanNL@users.noreply.github.com>
Co-authored-by: DutchmanNL <7318445+DutchmanNL@users.noreply.github.com>
Copilot AI changed the title [WIP] ensure versioning labels are working Fix GitHub version badge and simplify Quick Start section Sep 19, 2025
Copilot AI requested a review from DutchmanNL September 19, 2025 00:55
@DutchmanNL DutchmanNL marked this pull request as ready for review September 19, 2025 00:55
Copilot AI review requested due to automatic review settings September 19, 2025 00:56
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 fixes the non-functional GitHub version badge by adding a package.json file and enhances the version management system to support it. The changes also simplify the Quick Start section by removing verbose setup instructions.

Key changes:

  • Added comprehensive package.json file with proper metadata and version management integration
  • Enhanced scripts/manage-versions.sh to handle package.json version updates automatically
  • Streamlined README Quick Start section by removing redundant setup instructions

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.

File Description
package.json New file providing version metadata for GitHub badge and npm-style project structure
scripts/manage-versions.sh Enhanced to automatically manage package.json version alongside existing files
tests/test-manage-versions.sh Added comprehensive test coverage for new package.json version management functionality
README.md Simplified Quick Start section by removing verbose setup instructions

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@DutchmanNL DutchmanNL merged commit f10256d into main Sep 19, 2025
1 check passed
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.

ensure versioning labels are working

3 participants