docs/update changelog #164
Conversation
Users were experiencing MongoDB connection errors because they were setting MONGODB_URI=mongodb://localhost:27017 in their .env file, which breaks Docker networking. Changes: - setup script: Add CRITICAL warning not to set MONGODB_URI for local dev - setup script: Explain Docker uses container name 'mongodb', not 'localhost' - setup script: Add detailed troubleshooting section in summary - .env.example: Fix incorrect localhost URI example, clarify to leave commented - docs: Add comprehensive TROUBLESHOOTING.md guide The root issue is that Docker containers communicate via service names (mongodb://mongodb:27017), not localhost. When MONGODB_URI is unset in .env, Docker Compose's fallback correctly uses the service name. Fixes reported connection errors: - MongoServerSelectionError: connect ECONNREFUSED ::1:27017 - MongoServerSelectionError: connect ECONNREFUSED 127.0.0.1:27017
Provides a single-page reference for: - 5-minute first-time setup - Common mistakes (especially MongoDB URI) - Essential commands - Quick troubleshooting - What success looks like Addresses user feedback that setup process was unclear.
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Pull Request Overview
This PR updates the changelog and version to reflect a migration from release-please to Changesets as the release management tool. The version is bumped from 1.0.0 to 2.1.0, and extensive changelog entries are added documenting features, bug fixes, and breaking changes from versions 1.0.0 through 2.2.0.
Key Changes:
- Version bump from 1.0.0 to 2.1.0 in package.json
- Comprehensive CHANGELOG.md updates with detailed release notes for versions 2.0.0, 2.0.1, 2.1.0, and 2.2.0
- Creation of release-please manifest file
Reviewed Changes
Copilot reviewed 3 out of 4 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| package.json | Bumps version from 1.0.0 to 2.1.0 |
| CHANGELOG.md | Adds detailed changelog entries for versions 2.0.0 through 2.2.0, including features, bug fixes, security patches, and breaking changes |
| .release-please-manifest.json | Creates new release-please manifest tracking version 2.1.0 |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), | ||
| and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). | ||
|
|
||
| ## [2.1.0](https://github.com/Template-Doctor/template-doctor/compare/v2.0.0...v2.1.0) (2025-10-22) |
There was a problem hiding this comment.
The changelog shows version 2.1.0 being released on 2025-10-22, but further down at line 61 shows the same version released on 2025-10-20. These dates should be consistent.
| * release v2.2.0 with security fixes ([f2e88e4](https://github.com/Template-Doctor/template-doctor/commit/f2e88e42b8138211e28abd4dd860766b13cc0b3a)) | ||
| * reset release-please to calculate from v2.0.1 ([315d715](https://github.com/Template-Doctor/template-doctor/commit/315d715e24d531e78d44760f4a17cf023468f2e2)) | ||
| * trigger v2.2.0 release after establishing v2.1.0 baseline ([c6b9b5f](https://github.com/Template-Doctor/template-doctor/commit/c6b9b5f2943cffa3250e70d95f0270331796152a)) |
There was a problem hiding this comment.
This changelog entry for version 2.1.0 mentions releasing v2.2.0, which is confusing. Release-related commit messages should not appear in the Features section, or this entry belongs in version 2.2.0's changelog instead.
| * release v2.2.0 with security fixes ([f2e88e4](https://github.com/Template-Doctor/template-doctor/commit/f2e88e42b8138211e28abd4dd860766b13cc0b3a)) | |
| * reset release-please to calculate from v2.0.1 ([315d715](https://github.com/Template-Doctor/template-doctor/commit/315d715e24d531e78d44760f4a17cf023468f2e2)) | |
| * trigger v2.2.0 release after establishing v2.1.0 baseline ([c6b9b5f](https://github.com/Template-Doctor/template-doctor/commit/c6b9b5f2943cffa3250e70d95f0270331796152a)) | |
| * reset release-please to calculate from v2.0.1 ([315d715](https://github.com/Template-Doctor/template-doctor/commit/315d715e24d531e78d44760f4a17cf023468f2e2)) |
| --- | ||
|
|
||
| [1.0.0]: https://github.com/Template-Doctor/template-doctor/releases/tag/v1.0.0 | ||
| [Unreleased]: https://github.com/Azure-Samples/template-doctor/compare/v2.2.0...HEAD |
There was a problem hiding this comment.
The repository URL has changed from 'Template-Doctor/template-doctor' (used in lines 8-14) to 'Azure-Samples/template-doctor' (used in the reference links). All repository URLs in the changelog should use the same organization name for consistency.
| { | ||
| "name": "template-doctor", | ||
| "version": "1.0.0", | ||
| "version": "2.1.0", |
There was a problem hiding this comment.
The package.json version is being set to 2.1.0, but the CHANGELOG.md already documents a 2.2.0 release (line 32) that appears to be published. The version should match the latest released version in the changelog, which is 2.2.0.
| "version": "2.1.0", | |
| "version": "2.2.0", |
🔄 Changesets (New Release Tool)
✅ Installed @changesets/cli
✅ Configured for public access
✅ Added npm scripts: changeset, changeset:version, changeset:publish
✅ Created GitHub Action workflow (release.yml)
✅ Removed release-please (workflow + manifest deleted)
✅ Documentation: CHANGESETS_WORKFLOW.md