chore(CHANGELOG.md): update (#16)

## Summary by Sourcery

Release version 0.2.0 with updated changelog and refined continuous delivery workflow for changelog generation, artifact handling, and GitHub release creation.

CI:
- Allow manual triggering of the CD workflow via workflow_dispatch
- Merge changelog and build jobs to streamline the release pipeline
- Use uvx git-cliff to generate separate RELEASE_BODY.md and CHANGELOG.md files
- Upload and download release body and distribution artifacts using actions/upload-artifact@v4 and actions/download-artifact@v4
- Upgrade action versions and adjust artifact paths for consistency in build, release, and publish jobs
- Configure GitHub release action to use body_path for release notes

Documentation:
- Update CHANGELOG.md with version 0.2.0, release date, and reference links
- Refine cliff.toml footer template to include version reference links

Chores:
- Add mise.toml to pin tool versions for changie, git-cliff, gitversion, goreleaser, and other release utilities

Author: hasansezertasan

.cliffignore

@@ -2,3 +2,7 @@
 
 e8759bdeb573cd9304d1fb6e0501906ea9cb865a
 32e8972a53899a022ab56f9eaed2b5e0d621bbdb
+a69848578e1e730504fb322530e1351077aada24
+e6d5d4b172580dc13bdc44e3f4c78cfbcc1390d4
+a159e02a99260b5df1500f21c78295edf922f0ee
+7be7e9e56e7404d09753aa224cece00b148c25f6

.github/workflows/cd.yml

@@ -1,34 +1,18 @@
 ---
 name: CD
 on:
+  workflow_dispatch:  # Allows manual triggering of the workflow
   push:
     tags:
       - "*" # Will trigger for every tag, alternative: 'v*'
 jobs:
-  changelog:
-    name: Generate changelog
+  build:
     runs-on: ubuntu-latest
-    outputs:
-      release_body: ${{ steps.git-cliff.outputs.content }}
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
         with:
           fetch-depth: 0
-      - name: Generate a changelog
-        uses: orhun/git-cliff-action@v4
-        id: git-cliff
-        with:
-          args: --latest --no-exec --strip header
-        env:
-          OUTPUT: CHANGELOG.md
-          GITHUB_REPO: ${{ github.repository }}
-  build:
-    runs-on: ubuntu-latest
-    needs: changelog
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v4
       - name: Set up Python
         uses: actions/setup-python@v5
         with:
@@ -41,11 +25,21 @@ jobs:
       - name: Restore cache
         if: steps.setup-uv.outputs.cache-hit == 'true'
         run: echo "Cache was restored"
+      - name: Generate Changelog
+        run: |
+            uvx git-cliff --latest --no-exec --strip all --github-repo ${{ github.repository }} > RELEASE_BODY.md
+            uvx git-cliff --github-repo ${{ github.repository }} > CHANGELOG.md
+      - name: Upload Release Body
+        uses: actions/upload-artifact@v4
+        with:
+          name: release_body
+          path: RELEASE_BODY.md
       - name: Build the Package
         run: uv build --no-sources --quiet
       - name: Upload Artifacts
         uses: actions/upload-artifact@v4.6.2
         with:
+          name: dist
           path: ./dist
   release:
     needs: build
@@ -54,14 +48,26 @@ jobs:
       contents: write # IMPORTANT: Mandatory for GitHub Release (action-gh-release)
       discussions: write # IMPORTANT: Mandatory for Discussions (action-gh-release)
     steps:
+      - name: Download Release Body
+        uses: actions/download-artifact@v4
+        with:
+          name: release_body
+          path: .
+      - name: Let's see the Release Body
+        run: cat ./RELEASE_BODY.md
       - name: Download Artifacts
-        uses: actions/download-artifact@v4.3.0
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: ./dist
+      - name: Let's see the Release Artifacts
+        run: ls ./dist
       - name: Create GitHub Release
         uses: softprops/action-gh-release@v2.3.2
         if: github.ref_type == 'tag'
         with:
-          files: artifacts/
-          body: ${{ needs.changelog.outputs.release_body }}
+          files: ./dist/*
+          body_path: ./RELEASE_BODY.md
           discussion_category_name: Announcements
   publish-pypi:
     needs: release
@@ -73,9 +79,10 @@ jobs:
       name: publish
       url: https://pypi.org/project/micoo/${{ github.ref_name }}
     steps:
-      - name: Download Artifacts
-        uses: actions/download-artifact@v4.3.0
+      - name: Download artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: ./dist
       - name: Publish to PyPI
         uses: pypa/gh-action-pypi-publish@v1.12.4
-        with:
-          packages-dir: artifact/

CHANGELOG.md

@@ -7,10 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 <!-- changelog-start -->
 
-## [Unreleased]
+## [0.2.0] - 2025-07-27
 
 ### Changed
 
+- Git-cliff integration by @hasansezertasan in [#6](https://github.com/hasansezertasan/micoo/pull/6)
 - Implement dynamic arguments and pin python version to 3.9 by @hasansezertasan in [#4](https://github.com/hasansezertasan/micoo/pull/4)
 - Generate release notes and discussions on gh-release, adjust permissions, bump setup-uv version by @hasansezertasan in [#3](https://github.com/hasansezertasan/micoo/pull/3)
 
@@ -34,6 +35,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - @hasansezertasan made their first contribution
 
 <!-- refs -->
-[unreleased]: https://github.com/hasansezertasan/micoo/compare/0.1.0..HEAD
+[0.1.0]: https://github.com/hasansezertasan/micoo/tree/0.1.0
+[0.2.0]: https://github.com/hasansezertasan/micoo/compare/0.1.0..0.2.0
 
 <!-- changelog-end -->

cliff.toml

@@ -50,7 +50,8 @@ body = """
 # A Tera template to be rendered as the changelog's footer.
 # See https://keats.github.io/tera/docs/#introduction
 footer = """
-{{ "\n" }}<!-- refs -->{{ "\n" }}
+{{ "\n" }}<!-- refs -->
+[0.1.0]: https://github.com/hasansezertasan/micoo/tree/0.1.0{{ "\n" }}
 {%- macro remote_url() -%}
   https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }}
 {%- endmacro -%}

mise.toml

@@ -0,0 +1,8 @@
+[tools]
+changie = "latest"
+committed = "latest"
+git-cliff = "latest"
+gitversion = "latest"
+goreleaser = "latest"
+"pipx:commitizen" = "latest"
+"ubi:rhysd/changelog-from-release" = "latest"