Merge pull request #1 from LexianDEV/copilot/fix-32610bab-38be-4026-84b8-7f04d46709c4

Switch from auto-generated release notes to Keep A Changelog format with documentation

Author: Lexian-droid

.github/workflows/build_for_linux.yml

@@ -41,12 +41,34 @@ jobs:
           name: dev-build
           path: dist
 
+      - name: Extract changelog entry
+        if: startsWith(github.ref, 'refs/tags/')
+        id: changelog
+        run: |
+          version=${GITHUB_REF_NAME#v}
+          echo "Extracting changelog for version $version"
+          
+          # Extract the changelog section for this version
+          if grep -q "## \[$version\]" CHANGELOG.md; then
+            # Extract content between this version and the next version heading or links section
+            changelog_content=$(awk "/## \[$version\]/{flag=1; next} /## \[|^\[.*\]:/{flag=0} flag" CHANGELOG.md | sed '/^$/d')
+            echo "Changelog content found for version $version"
+          else
+            echo "No changelog entry found for version $version, using default message"
+            changelog_content="Release $version - See CHANGELOG.md for details"
+          fi
+          
+          # Store in output for use in release step
+          echo "content<<EOF" >> $GITHUB_OUTPUT
+          echo "$changelog_content" >> $GITHUB_OUTPUT
+          echo "EOF" >> $GITHUB_OUTPUT
+
       - name: Upload Release Asset
         if: startsWith(github.ref, 'refs/tags/')
         uses: softprops/action-gh-release@v1
         with:
           files: dist/Application
           prerelease: ${{ startsWith(github.ref_name, 'b') }}
-          generate_release_notes: true
+          body: ${{ steps.changelog.outputs.content }}
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/build_for_windows..yml

@@ -36,12 +36,35 @@ jobs:
           name: dev-build
           path: dist
 
+      - name: Extract changelog entry
+        if: startsWith(github.ref, 'refs/tags/')
+        id: changelog
+        shell: bash
+        run: |
+          version=${GITHUB_REF_NAME#v}
+          echo "Extracting changelog for version $version"
+          
+          # Extract the changelog section for this version
+          if grep -q "## \[$version\]" CHANGELOG.md; then
+            # Extract content between this version and the next version heading or links section
+            changelog_content=$(awk "/## \[$version\]/{flag=1; next} /## \[|^\[.*\]:/{flag=0} flag" CHANGELOG.md | sed '/^$/d')
+            echo "Changelog content found for version $version"
+          else
+            echo "No changelog entry found for version $version, using default message"
+            changelog_content="Release $version - See CHANGELOG.md for details"
+          fi
+          
+          # Store in output for use in release step
+          echo "content<<EOF" >> $GITHUB_OUTPUT
+          echo "$changelog_content" >> $GITHUB_OUTPUT
+          echo "EOF" >> $GITHUB_OUTPUT
+
       - name: Upload Release Asset
         if: startsWith(github.ref, 'refs/tags/')
         uses: softprops/action-gh-release@v1
         with:
           files: dist/Application.exe
           prerelease: ${{ startsWith(github.ref_name, 'b') }}
-          generate_release_notes: true
+          body: ${{ steps.changelog.outputs.content }}
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

CHANGELOG.md

@@ -0,0 +1,26 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+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).
+
+## [Unreleased]
+
+### Changed
+- Switched from auto-generated release notes to Keep A Changelog format
+
+## [1.0.0] - 2024-08-22
+
+### Added
+- Initial Python template application
+- Basic time display functionality
+- PyInstaller build configuration for Linux and Windows
+- GitHub Actions workflows for automated builds
+- Cross-platform executable generation
+
+### Fixed
+- Initial release with basic functionality
+
+[Unreleased]: https://github.com/LexianDEV/general-py-template/compare/v1.0.0...HEAD
+[1.0.0]: https://github.com/LexianDEV/general-py-template/releases/tag/v1.0.0

readme.md

@@ -1,4 +1,85 @@
 ## Template
 This is a template for a **GENERAL APPLICATION** built in Python.
 
-It was developed by LexianDEV 
+It was developed by LexianDEV
+
+## Changelog Management
+
+This project uses the [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) format for documenting changes. The changelog is maintained in the `CHANGELOG.md` file and **must be edited manually** when making changes to the project.
+
+### How to Update the Changelog
+
+#### 1. Adding New Changes (Unreleased Section)
+When you make changes to the project, add them to the `[Unreleased]` section at the top of the changelog:
+
+```markdown
+## [Unreleased]
+
+### Added
+- New feature you added
+
+### Changed
+- Something you modified
+
+### Deprecated
+- Feature that will be removed in future versions
+
+### Removed
+- Feature you removed
+
+### Fixed
+- Bug you fixed
+
+### Security
+- Security improvement you made
+```
+
+#### 2. Creating a New Release
+When you're ready to release a new version:
+
+1. **Move unreleased changes** from the `[Unreleased]` section to a new version section
+2. **Set the release date** in the format `[X.Y.Z] - YYYY-MM-DD`
+3. **Update the links** at the bottom of the file
+4. **Leave the `[Unreleased]` section empty** for future changes
+
+Example:
+```markdown
+## [Unreleased]
+
+## [1.1.0] - 2024-12-20
+
+### Added
+- New feature you added
+
+### Fixed
+- Bug you fixed
+
+## [1.0.0] - 2024-08-22
+...
+```
+
+#### 3. Automated Release Integration
+The GitHub Actions workflows automatically extract the appropriate changelog section for each release:
+- When you create a tag/release, the workflow finds the matching version in the changelog
+- It extracts only that version's content for the release notes
+- If no matching section is found, it provides a fallback message
+
+### Best Practices
+
+- **Always update the changelog** when making meaningful changes
+- **Use present tense** for changelog entries ("Add feature" not "Added feature")
+- **Be specific and clear** about what changed
+- **Group related changes** under the appropriate category
+- **Link to issues/PRs** when relevant using `[#123](link)` format
+- **Follow semantic versioning** for version numbers
+
+### Example Workflow
+
+1. Make changes to your code
+2. Add entries to the `[Unreleased]` section in `CHANGELOG.md`
+3. Commit your changes
+4. When ready to release:
+   - Move unreleased items to a new version section
+   - Update version links
+   - Create a git tag
+   - GitHub Actions will automatically create a release with the changelog content