Skip to main content

Personal dev workflow toolkit: unified logging + emoji commit conventions

Project description

zendev

Personal dev workflow toolkit: unified logging + emoji commit conventions.

Reusable commit-msg hook

This repository now publishes a reusable pre-commit/prek hook: zendev-commit-msg.

It validates commit titles against zendev's emoji commit schema:

  • ✨ feat: add export
  • 🐛 fix(parser): handle null token
  • 📝 docs: update README

It also allows common git-generated commit messages such as merge, revert, fixup!, and squash!.

Messages like feat: add export are rejected because the emoji prefix is required.

Use from another repository

With .pre-commit-config.yaml:

repos:
  - repo: https://github.com/your-org/zendev
    rev: v0.1.0
    hooks:
      - id: zendev-commit-msg

With prek.toml:

[[repos]]
repo = "https://github.com/your-org/zendev"
rev = "v0.1.0"
hooks = [
  { id = "zendev-commit-msg" },
]

Then install the hook:

uvx prek install --hook-type commit-msg

GitHub Actions: validate PR titles and bodies

This repository now ships both the Python CLIs and the thin composite-action wrappers under actions/, so one zendev revision owns the full PR validation stack.

Use inside this repository

Check out the repo, then call the local actions:

# .github/workflows/ci-pr-checks.yml
name: CI - PR Checks

on:
  pull_request:
    types: [opened, edited, synchronize, reopened]

jobs:
  title:
    runs-on: ubuntu-latest
    permissions:
      pull-requests: read
    steps:
      - uses: actions/checkout@v4
      - uses: ./actions/validate-title
        with:
          text: ${{ github.event.pull_request.title }}

  body:
    runs-on: ubuntu-latest
    permissions:
      pull-requests: read
    steps:
      - uses: actions/checkout@v4
      - uses: ./actions/validate-body
        with:
          body: ${{ github.event.pull_request.body }}

Use from another repository

Pin the action path in this repository:

jobs:
  title:
    runs-on: ubuntu-latest
    permissions:
      pull-requests: read
    steps:
      - uses: zrr1999/zendev/actions/validate-title@<ref>
        with:
          text: ${{ github.event.pull_request.title }}
jobs:
  body:
    runs-on: ubuntu-latest
    permissions:
      pull-requests: read
    steps:
      - uses: zrr1999/zendev/actions/validate-body@<ref>
        with:
          body: ${{ github.event.pull_request.body }}

By default, each wrapper runs the CLI from the same checked-out or pinned zendev revision as the action itself. That keeps the wrapper and Python logic in sync.

Both actions also accept an optional zendev-ref input. Leave it unset for the same-revision default, or pass a git ref if you intentionally want the wrapper to install zendev from a different revision during a rollout.

Use inside this repository

just install

That installs both pre-commit and commit-msg hooks for local development.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

zendev-0.0.5-py3-none-any.whl (9.3 kB view details)

Uploaded Python 3

File details

Details for the file zendev-0.0.5-py3-none-any.whl.

File metadata

  • Download URL: zendev-0.0.5-py3-none-any.whl
  • Upload date:
  • Size: 9.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for zendev-0.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 b0f23db0a5a54deaeefb7e11b2fd3cdb6eb111d63b363be267cd6c1ebea9290e
MD5 d8e8ceb2aa67c2d16ecb1af6717cb50c
BLAKE2b-256 143bb323f0a8a786d4a20f10cc11d133824cd5e5e9726a77ec0ba420ee096734

See more details on using hashes here.

Provenance

The following attestation bundles were made for zendev-0.0.5-py3-none-any.whl:

Publisher: cd-release.yml on zendev-lab/zendev

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page