Skip to content

docs: Clarify git.sign-on-push documented behavior - #9927

Open
masterzen wants to merge 1 commit into
jj-vcs:mainfrom
masterzen:masterzen/clarify-git-sign-on-push-documented-behavior
Open

docs: Clarify git.sign-on-push documented behavior#9927
masterzen wants to merge 1 commit into
jj-vcs:mainfrom
masterzen:masterzen/clarify-git-sign-on-push-documented-behavior

Conversation

@masterzen

Copy link
Copy Markdown

What?

This is a very short documentation rewrite for clarifying the behavior of push-time signing, and explaining that for being effective it requires the drop signing behavior.

Why?

The current documentation doesn't make it clear that for git.sign-on-push to be really effective, the drop behavior has to be selected, even though the example shows it.

Checklist

If applicable:

  • [ ] I have updated CHANGELOG.md
  • I have updated the documentation (README.md, docs/, demos/)
  • [ ] I have updated the config schema (cli/src/config-schema.json)
  • [ ] I have added/updated tests to cover my changes
  • [ ] I fully understand the code that I am submitting (what it does,
    how it works, how it's organized), including any code drafted by an LLM.
  • For any prose generated by an LLM, I have proof-read and copy-edited with
    an eye towards deleting anything that is irrelevant, clarifying anything
    that is confusing, and adding details that are relevant. This includes,
    for example, commit descriptions, PR descriptions, and code comments.

@masterzen
masterzen requested a review from a team as a code owner August 6, 2026 06:56

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The following commits do not follow our format for subject lines:

  • b89a1e1: Clarify git.sign-on-push documented behavior

Commits should have a subject line following the format <topic>: <description>. Please review the commit guidelines for more information.

@google-cla

google-cla Bot commented Aug 6, 2026

Copy link
Copy Markdown

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

@masterzen
masterzen force-pushed the masterzen/clarify-git-sign-on-push-documented-behavior branch from b89a1e1 to 9b7d89f Compare August 6, 2026 07:00
@github-actions
github-actions Bot dismissed their stale review August 6, 2026 07:01

All commits are now correctly formatted. Thank you for your contribution!

@masterzen masterzen changed the title Clarify git.sign-on-push documented behavior docs: Clarify git.sign-on-push documented behavior Aug 6, 2026
Comment thread docs/config.md Outdated
Comment thread docs/config.md Outdated
Comment thread docs/config.md Outdated
@masterzen
masterzen force-pushed the masterzen/clarify-git-sign-on-push-documented-behavior branch from 9b7d89f to 99c3a9b Compare August 6, 2026 15:54
Comment thread docs/config.md Outdated
The current documentation doesn't make it clear that for
git.sign-on-push to be really effective, the `drop` behavior has to be
selected. 

This clarifies the text by explaining the behavior of push-time signing.

JJ-Change-Id: qrytksrnvunv
@masterzen
masterzen force-pushed the masterzen/clarify-git-sign-on-push-documented-behavior branch from 99c3a9b to cc02edd Compare August 6, 2026 20:15
@masterzen
masterzen requested a review from josephlou5 August 9, 2026 17:47

@josephlou5 josephlou5 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Needs maintainer approval

Edit: I'm also not an expert by any means on signing (never used the feature), so my review is purely just on wording and understandability.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants