Skip to main content

A pre-commit integration for jj

Project description

jj-pre-push

PyPI

A very limited integration between jj and pre-commit allowing you to run your pre-push hooks in a colocated jj/git repository.

I don't expect this to last forever, it's just a stopgap until some jj-native mechanism arrives that can take over.

Prior art:

Usage

Use jj-pre-push push (or an alias - personally I use jj push) as a replacement for jj git push. It takes all the same arguments, and does the following:

  1. Determines which bookmarks the corresponding jj git push will update on the remote, and how they would change.
  2. For each of these bookmarks in turn:
    • Checks out the bookmark to the working copy
    • Runs the pre-push hooks defined in your .pre-commit-config.yaml on the same set of files pre-commit would when pushing the same change. (For existing branches that's the files touched in the range old...new; for new branches it's the files touched in all ancestors of new that aren't present on the remote.)
    • Reports any failures; and if any files were modified reports the change ID(s) in which these modifications can be found.
  3. If all hooks succeeded on all branches, executes jj git push with the arguments provided; otherwise nothing is pushed.
  4. Returns the working copy to its original change.

If there is no .pre-commit-config.yaml in your workspace root, jj-pre-push push immediately delegates to jj git push.

By default jj-pre-push produces no console output of its own unless hooks fail. If you'd like to see more details about what's happening, you can use jj-pre-push --log-level=INFO push.

Installation

If you have uv installed and you're planning to use an alias anyway, you can avoid explicitly installing at all with uvx, e.g. with this jj configuration for jj push:

[aliases]
push = ["util", "exec", "--", "uvx", "jj-pre-push", "push"]

Otherwise, install the PyPI package jj-pre-push in whichever way you prefer; e.g. uv tool install jj-pre-push or pip install jj-pre-push, and use jj-pre-push push as described earlier.

Usage with jjui

If you're a jjui fan (I think maybe you should be!), here's an example jjui/config.toml snippet showing how you can define custom commands to invoke jj-pre-push: one to perform the default jj push, and one to push the bookmarks attached to the change you have currently selected in the UI.

[custom_commands]
"jj push" = { key = ["p"], args = ["push"] }
"jj push selected bookmark(s)" = { key = ["P"], args = ["push", "-r", "$change_id"] }

Note that these depend upon the jj push alias defined in the previous section.

Project details


Download files

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

Source Distribution

jj_pre_push-0.2.0.tar.gz (5.7 kB view details)

Uploaded Source

Built Distribution

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

jj_pre_push-0.2.0-py3-none-any.whl (7.3 kB view details)

Uploaded Python 3

File details

Details for the file jj_pre_push-0.2.0.tar.gz.

File metadata

  • Download URL: jj_pre_push-0.2.0.tar.gz
  • Upload date:
  • Size: 5.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.3

File hashes

Hashes for jj_pre_push-0.2.0.tar.gz
Algorithm Hash digest
SHA256 4996eddacb6177b0e1d03726dc2253f3825c3b437b290c58a8a8e1e869b3a921
MD5 70ae2148a8fd17303050a75bb1a9f482
BLAKE2b-256 e535e46c7f501e466ec08b5d56a27c74d3e66fbaa8ef860266a9ef2f228a4f9b

See more details on using hashes here.

File details

Details for the file jj_pre_push-0.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for jj_pre_push-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d1db0b73f585a648b02e99d04448e21b6e57906d8c8be80fd59f77197e0f6167
MD5 8ce9a28786198bce1bb57f339be722a2
BLAKE2b-256 3ff6039a814237ab806310957e54aa1b536578f88e50c4a24967f3c5c232dd0a

See more details on using hashes here.

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