Skip to content

Correct auto tag functionality#22

Open
playmiel wants to merge 2 commits intomainfrom
dev
Open

Correct auto tag functionality#22
playmiel wants to merge 2 commits intomainfrom
dev

Conversation

@playmiel
Copy link
Owner

@playmiel playmiel commented Mar 20, 2026

This pull request primarily updates the project for a new release, synchronizing version metadata across files and introducing a changelog for improved documentation. No functional code changes are included; the focus is on project maintenance and clarity.

Release and metadata synchronization:

  • Updated the project version to 2.1.2 in library.json, library.properties, and src/HttpCommon.h to ensure consistency across all metadata sources. [1] [2] [3]
  • Reformatted library.json to use consistent array formatting for platforms and frameworks.

Documentation improvements:

  • Added a new CHANGELOG.md file detailing notable changes, bug fixes, performance improvements, and features for recent and past releases.

Summary by CodeRabbit

  • Documentation

    • Added comprehensive changelog documenting project release history and prior versions.
  • Chores

    • Bumped library version to 2.1.2.
    • Updated version references across project metadata files.

@playmiel playmiel self-assigned this Mar 20, 2026
@playmiel playmiel added the bug Something isn't working label Mar 20, 2026
Copilot AI review requested due to automatic review settings March 20, 2026 14:19
@coderabbitai
Copy link

coderabbitai bot commented Mar 20, 2026

📝 Walkthrough

Walkthrough

Version 2.1.2 release preparation: Updates version metadata across library.json, library.properties, and HttpCommon.h from 2.1.1 to 2.1.2, adds CHANGELOG.md with release history, and removes CHANGELOG.md from .gitignore to track it in the repository.

Changes

Cohort / File(s) Summary
Version Metadata Updates
library.json, library.properties, src/HttpCommon.h
Bumped library version from 2.1.1 to 2.1.2 across all metadata files. library.json also reformatted arrays to multi-line format.
Release Documentation
CHANGELOG.md
Added new CHANGELOG.md documenting project release history with [Unreleased] section and entries for versions 2.1.2, 2.1.0, 2.0.0, and 1.0.7, detailing bug fixes, features, and breaking changes.
Git Configuration
.gitignore
Removed CHANGELOG.md from ignore rules to track the changelog file in the repository.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related PRs

  • 2.1.1 #21: Introduces version bumping and release artifacts by updating library.json, library.properties, and HttpCommon.h to 2.1.2, and adding CHANGELOG.md documentation—directly aligned with these same version and release tracking changes.

Poem

🐰 A changelog blooms, version two-point-two,
Metadata synced, git tracking true,
From 2.1.1 we hop and we bound,
Release notes rest where all can be found! 📚✨

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Title check ⚠️ Warning The title 'Correct auto tag functionality' does not match the changeset, which contains only version bumps and documentation updates with no changes to auto tag functionality. Revise the title to accurately reflect the actual changes, such as 'Release version 2.1.2' or 'Add CHANGELOG and bump version to 2.1.2'.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch dev
📝 Coding Plan
  • Generate coding plan for human review comments

Comment @coderabbitai help to get the list of available commands and usage tips.

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

Prepares the repository for the 2.1.2 release by synchronizing version metadata across distribution files and adding a changelog to document releases.

Changes:

  • Bumped project version to 2.1.2 across src/HttpCommon.h, library.properties, and library.json.
  • Reformatted library.json array fields for consistent formatting.
  • Added CHANGELOG.md and ensured it is tracked by git (removed from .gitignore).

Reviewed changes

Copilot reviewed 4 out of 5 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
src/HttpCommon.h Updates in-code version macro to 2.1.2.
library.properties Updates Arduino library version to 2.1.2.
library.json Updates PlatformIO/library version to 2.1.2 and normalizes array formatting.
CHANGELOG.md Introduces a changelog documenting release history and the new 2.1.2 entry.
.gitignore Stops ignoring CHANGELOG.md so it can be committed.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines 1 to 4
{
"name": "ESPAsyncWebClient",
"version": "2.1.1",
"version": "2.1.2",
"description": "Asynchronous HTTP client library for ESP32 ",
Copy link

Copilot AI Mar 20, 2026

Choose a reason for hiding this comment

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

The PR title ("Correct auto tag functionality") doesn’t match the actual changes here (version/metadata bump + formatting). This makes the intent of the release harder to track in history and automation; please align the title and/or PR description to reflect the version sync + changelog addition (or add the missing functional changes if they were intended).

Copilot uses AI. Check for mistakes.
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

🧹 Nitpick comments (1)
CHANGELOG.md (1)

15-17: Consider reducing repeated bullet starters for readability.

Several consecutive bullets start with identical prefixes (**Fix** / **Breaking**). Optional wording variation would make scanning easier.

Also applies to: 27-28

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@CHANGELOG.md` around lines 15 - 17, The CHANGELOG contains several
consecutive bullets starting with identical starters like `**Fix**` and
`**Breaking**`, making it harder to scan; update the bullets (the lines
containing the `**Fix**`/`**Breaking**` markers) to reduce repetition by varying
the starter wording (e.g., alternate with "Fixes", "Bugfix", "Changed", or merge
related fixes under a single `**Fix**` entry) or group related items into a
single bullet with sub-items, ensuring the existing entries about
`Content-Length` parsing, `Transfer-Encoding` multi-value support, and
`setMaxBodySize()` enforcement remain unchanged in content but are reformatted
for readability.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@CHANGELOG.md`:
- Around line 15-17: The CHANGELOG contains several consecutive bullets starting
with identical starters like `**Fix**` and `**Breaking**`, making it harder to
scan; update the bullets (the lines containing the `**Fix**`/`**Breaking**`
markers) to reduce repetition by varying the starter wording (e.g., alternate
with "Fixes", "Bugfix", "Changed", or merge related fixes under a single
`**Fix**` entry) or group related items into a single bullet with sub-items,
ensuring the existing entries about `Content-Length` parsing,
`Transfer-Encoding` multi-value support, and `setMaxBodySize()` enforcement
remain unchanged in content but are reformatted for readability.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 0c07b26d-b422-4c7b-923b-cc9daa4159d0

📥 Commits

Reviewing files that changed from the base of the PR and between 0d95317 and 0804dd2.

📒 Files selected for processing (5)
  • .gitignore
  • CHANGELOG.md
  • library.json
  • library.properties
  • src/HttpCommon.h
💤 Files with no reviewable changes (1)
  • .gitignore

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants