cz-changeup 0.1.0__tar.gz

cz_changeup-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,55 @@
+name: Release
+
+on:
+  push:
+    branches: [ "main" ]
+env:
+  FORCE_COLOR: 1
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    concurrency:
+      group: release
+    environment:
+      name: pypi
+      url: https://pypi.org/p/cz-changeup
+    permissions:
+      id-token: write
+      contents: write
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Run commitizen
+        if: ${{ !startsWith(github.event.head_commit.message, 'bump:') }}
+        id: cz
+        uses: commitizen-tools/commitizen-action@master
+        with:
+          extra_requirements : "."
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          changelog_increment_filename: body.md
+
+      - name: Build package distributions
+        id: build
+        if: env.REVISION != env.PREVIOUS_REVISION
+        run: |
+          pipx run build
+
+      - name: Publish package distributions to PyPI
+        id: pypi-publish
+        if: env.REVISION != env.PREVIOUS_REVISION
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          verbose: true
+
+      - name: Publish package distributions to GitHub Releases
+        id: github-release
+        if: env.REVISION != env.PREVIOUS_REVISION
+        uses: softprops/action-gh-release@v2
+        with:
+          body_path: "body.md"
+          tag_name: v${{ steps.cz.outputs.version }}
+          token: ${{ secrets.GITHUB_TOKEN }}

cz_changeup-0.1.0/.gitignore

@@ -0,0 +1,227 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+!.vscode/*.code-snippets
+
+# Local History for Visual Studio Code
+.history/
+
+# Built Visual Studio Code Extensions
+*.vsix
+
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+# Windows thumbnail cache files
+Thumbs.db
+Thumbs.db:encryptable
+ehthumbs.db
+ehthumbs_vista.db
+
+# Dump file
+*.stackdump
+
+# Folder config file
+[Dd]esktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msix
+*.msm
+*.msp
+
+# Windows shortcuts
+*.lnk

cz_changeup-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,50 @@
+ci:
+  autoupdate_commit_msg: "ci(pre-commit): pre-commit autoupdate"
+  autofix_commit_msg: "style: pre-commit auto fixes [...]"
+  autoupdate_schedule: monthly
+
+default_install_hook_types: [pre-commit, commit-msg]
+
+repos:
+
+  # Meta hooks
+  - repo: meta
+    hooks:
+      - id: check-hooks-apply
+      - id: check-useless-excludes
+
+  # Security & credential scanning/alerting
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
+    hooks:
+      - id: check-ast
+      - id: check-builtin-literals
+      - id: check-case-conflict
+      - id: check-merge-conflict
+      - id: check-toml
+      - id: check-vcs-permalinks
+      - id: check-yaml
+      - id: debug-statements
+      - id: detect-private-key
+      - id: end-of-file-fixer
+      - id: mixed-line-ending
+      - id: trailing-whitespace
+
+  # Lint and format with ruff
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    # Ruff version.
+    rev: v0.5.6
+    hooks:
+      # Run the linter.
+      - id: ruff
+        args: [ --fix ]
+      # Run the formatter.
+      - id: ruff-format
+
+  # # Commitizen
+  # - repo: https://github.com/commitizen-tools/commitizen
+  #   rev: v3.28.0
+  #   hooks:
+  #     - id: commitizen
+  #     - id: commitizen-branch
+  #       stages: [push]

cz_changeup-0.1.0/CHANGELOG.md

@@ -0,0 +1,5 @@
+## 0.1.0 (2024-08-15)
+
+### Feat
+
+- initial release

cz_changeup-0.1.0/PKG-INFO

@@ -0,0 +1,54 @@
+Metadata-Version: 2.3
+Name: cz-changeup
+Version: 0.1.0
+Summary: Commitizen plugin for better changelog generation
+Project-URL: Changelog, https://github.com/kmnhan/cz-changeup#changelog
+Project-URL: Documentation, https://github.com/kmnhan/cz-changeup#readme
+Project-URL: Issues, https://github.com/kmnhan/cz-changeup/issues
+Project-URL: Source, https://github.com/kmnhan/cz-changeup
+Author-email: Kimoon Han <khan@kaist.ac.kr>
+License-Expression: MIT
+Keywords: changelog,commitizen
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.8
+Requires-Dist: commitizen>=3.0.0
+Description-Content-Type: text/markdown
+
+# cz-changeup
+
+This plugin is a version of
+[Commitizen](https://commitizen-tools.github.io/commitizen/)'s default conventional
+style with a more informative changelog format.
+
+## Installation
+
+```bash
+    pip install cz-changeup
+```
+
+## Configuration
+
+Add to your `pyproject.toml`:
+
+```toml
+[tool.commitizen]
+name = "cz_changeup"
+```
+
+The behavior of the plugin can be customized by providing the following options under `tool.commitizen`:
+
+| Option                   | Description                                                                                           | Default | Example                        |
+| ------------------------ | ----------------------------------------------------------------------------------------------------- | ------- | ------------------------------ |
+| `changeup_repo_base_url` | The base URL for the repository. If given, adds a link to the commit for each entry in the changelog. | `""`    | `"https://github.com/my/repo"` |
+| `changeup_show_body`     | Whether to include the commit body in the changelog.                                                  | `true`  |                                |
+| `changeup_body_indent`   | The number of spaces to indent the commit body if `show_body` is set to `true`.                       | `2`     |                                |

cz_changeup-0.1.0/README.md

@@ -0,0 +1,28 @@
+# cz-changeup
+
+This plugin is a version of
+[Commitizen](https://commitizen-tools.github.io/commitizen/)'s default conventional
+style with a more informative changelog format.
+
+## Installation
+
+```bash
+    pip install cz-changeup
+```
+
+## Configuration
+
+Add to your `pyproject.toml`:
+
+```toml
+[tool.commitizen]
+name = "cz_changeup"
+```
+
+The behavior of the plugin can be customized by providing the following options under `tool.commitizen`:
+
+| Option                   | Description                                                                                           | Default | Example                        |
+| ------------------------ | ----------------------------------------------------------------------------------------------------- | ------- | ------------------------------ |
+| `changeup_repo_base_url` | The base URL for the repository. If given, adds a link to the commit for each entry in the changelog. | `""`    | `"https://github.com/my/repo"` |
+| `changeup_show_body`     | Whether to include the commit body in the changelog.                                                  | `true`  |                                |
+| `changeup_body_indent`   | The number of spaces to indent the commit body if `show_body` is set to `true`.                       | `2`     |                                |

cz_changeup-0.1.0/body.md

@@ -0,0 +1,10 @@
+## 0.1.0 (2024-08-15)
+
+### Feat
+
+- initial release
+
+[main 83b594c] bump: version 0.0.0 → 0.1.0
+ 2 files changed, 6 insertions(+), 1 deletion(-)
+ create mode 100644 CHANGELOG.md
+

cz_changeup-0.1.0/pyproject.toml

@@ -0,0 +1,45 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "cz-changeup"
+version = "0.1.0"
+description = "Commitizen plugin for better changelog generation"
+readme = "README.md"
+requires-python = ">=3.8"
+license = "MIT"
+keywords = ["changelog", "commitizen"]
+authors = [{ name = "Kimoon Han", email = "khan@kaist.ac.kr" }]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Natural Language :: English",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+]
+dependencies = ["commitizen>=3.0.0"]
+
+[project.urls]
+Changelog = "https://github.com/kmnhan/cz-changeup#changelog"
+Documentation = "https://github.com/kmnhan/cz-changeup#readme"
+Issues = "https://github.com/kmnhan/cz-changeup/issues"
+Source = "https://github.com/kmnhan/cz-changeup"
+
+[project.entry-points."commitizen.plugin"]
+cz_changeup = "cz_changeup.cz_changeup:ChangeupCz"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/cz_changeup"]
+
+[tool.commitizen]
+name = "cz_changeup"
+version_provider = "pep621"
+update_changelog_on_bump = true
+changelog_incremental = true

cz_changeup-0.1.0/src/cz_changeup/cz_changeup.py

@@ -0,0 +1,34 @@
+__all__ = ["ChangeupCz"]
+
+from commitizen import config, git
+from commitizen.cz.conventional_commits import ConventionalCommitsCz
+
+
+class ChangeupCz(ConventionalCommitsCz):
+    conf = config.read_cfg()
+
+    repo_base_url: str = conf.settings.get("changeup_repo_base_url", "").strip(" /")
+    show_body: bool = conf.settings.get("changeup_show_body", True)
+    body_indent: int = conf.settings.get("changeup_body_indent", 2)
+
+    def changelog_message_builder_hook(
+        self, parsed_message: dict, commit: git.GitCommit
+    ) -> dict | list | None:
+        msg = str(parsed_message["message"])
+
+        if self.repo_base_url:
+            msg = (
+                msg + f" ([{commit.rev[:7]}]({self.repo_base_url}/commit/{commit.rev}))"
+            )
+
+        if self.show_body and commit.body:
+            msg += f"\n\n{' ' * self.body_indent}"
+            body = commit.body.replace("\n", "\n" + (" " * self.body_indent))
+            msg += f"{body}"
+
+        parsed_message["message"] = msg
+        return parsed_message
+
+    @property
+    def template_extras(self) -> dict[str, str]:
+        return {"repo_base_url": self.repo_base_url}