docs: Clarify git.sign-on-push documented behavior - #9927
Open
masterzen wants to merge 1 commit into
Open
Conversation
There was a problem hiding this comment.
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.
|
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
force-pushed
the
masterzen/clarify-git-sign-on-push-documented-behavior
branch
from
August 6, 2026 07:00
b89a1e1 to
9b7d89f
Compare
github-actions
Bot
dismissed
their stale review
August 6, 2026 07:01
All commits are now correctly formatted. Thank you for your contribution!
josephlou5
reviewed
Aug 6, 2026
masterzen
force-pushed
the
masterzen/clarify-git-sign-on-push-documented-behavior
branch
from
August 6, 2026 15:54
9b7d89f to
99c3a9b
Compare
offbyone
reviewed
Aug 6, 2026
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
force-pushed
the
masterzen/clarify-git-sign-on-push-documented-behavior
branch
from
August 6, 2026 20:15
99c3a9b to
cc02edd
Compare
josephlou5
approved these changes
Aug 10, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
dropsigning behavior.Why?
The current documentation doesn't make it clear that for git.sign-on-push to be really effective, the
dropbehavior has to be selected, even though the example shows it.Checklist
If applicable:
[ ] I have updatedCHANGELOG.mdREADME.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.
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.