public inbox for git@vger.kernel.org 
 help / color / mirror / Atom feed
From: "Robin Jarry" <robin@jarry•cc>
To: <git@vger•kernel.org>
Cc: "Phillip Wood" <phillip.wood123@gmail•com>,
	"Ævar Arnfjörð Bjarmason" <avarab@gmail•com>,
	"Tim Culverhouse" <tim@timculverhouse•com>,
	"Nicolas Dichtel" <nicolas.dichtel@6wind•com>,
	"Bagas Sanjaya" <bagasdotme@gmail•com>,
	"Junio C Hamano" <gitster@pobox•com>,
	"Eric Sunshine" <sunshine@sunshineco•com>,
	"Michael Strawbridge" <michael.strawbridge@amd•com>
Subject: Re: [PATCH v5] send-email: export patch counters in validate environment
Date: Thu, 20 Apr 2023 21:16:05 +0200	[thread overview]
Message-ID: <CS1TOE1MCMH0.2OMA9UHSDG7RC@ringo> (raw)
In-Reply-To: <20230414155249.667180-1-robin@jarry.cc>

Robin Jarry, Apr 14, 2023 at 17:52:
> diff --git a/templates/hooks--sendemail-validate.sample b/templates/hooks--sendemail-validate.sample
> new file mode 100755
> index 000000000000..ad2f9a86473d
> --- /dev/null
> +++ b/templates/hooks--sendemail-validate.sample
> @@ -0,0 +1,77 @@
> +#!/bin/sh
> +
> +# An example hook script to validate a patch (and/or patch series) before
> +# sending it via email.
> +#
> +# The hook should exit with non-zero status after issuing an appropriate
> +# message if it wants to prevent the email(s) from being sent.
> +#
> +# To enable this hook, rename this file to "sendemail-validate".
> +#
> +# By default, it will only check that the patch(es) can be applied on top of
> +# the default upstream branch without conflicts in a secondary worktree. After
> +# validation (successful or not) of the last patch of a series, the worktree
> +# will be deleted.
> +#
> +# The following config variables can be set to change the default remote and
> +# remote ref that are used to apply the patches against:
> +#
> +#   sendemail.validateRemote (default: origin)
> +#   sendemail.validateRemoteRef (default: HEAD)
> +#
> +# Replace the TODO placeholders with appropriate checks according to your
> +# needs.
> +
> +validate_cover_letter() {
> +	file="$1"
> +	# TODO: Replace with appropriate checks (e.g. spell checking).
> +	true
> +}
> +
> +validate_patch() {
> +	file="$1"
> +	# Ensure that the patch applies without conflicts.
> +	git am -3 "$file" || return
> +	# TODO: Replace with appropriate checks for this patch
> +	# (e.g. checkpatch.pl).
> +	true

Hey folks,

I had an idea after sending v5. Instead of leaving TODO placeholders, it
would be nicer to introduce other git config sendemail.validate* options
specific to this hook template so that users can directly use it without
any modifications simply by setting options in their local clone:

    git config sendemail.validatePatchCmd 'tools/checkpatch.sh'
    git config sendemail.validateSeriesCmd 'make tests lint'

And reuse these commands if defined in the hook template.

What do you think?

  reply	other threads:[~2023-04-20 19:16 UTC|newest]

Thread overview: 21+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-04-11 11:47 [PATCH] send-email: export patch counters in validate environment Robin Jarry
2023-04-11 13:23 ` Phillip Wood
2023-04-11 16:28   ` Junio C Hamano
2023-04-11 17:13     ` Robin Jarry
2023-04-11 19:14       ` Junio C Hamano
2023-04-11 16:47   ` Robin Jarry
2023-04-12  9:54 ` [PATCH v2] " Robin Jarry
2023-04-12 17:53   ` Junio C Hamano
2023-04-12 18:33     ` Robin Jarry
2023-04-12 20:37       ` Junio C Hamano
2023-04-12 20:39         ` Robin Jarry
2023-04-12 21:48     ` Junio C Hamano
2023-04-12 21:45   ` [PATCH v3] " Robin Jarry
2023-04-13 13:52     ` Phillip Wood
2023-04-13 14:01       ` Robin Jarry
2023-04-14 12:58         ` Phillip Wood
2023-04-14 15:28     ` [PATCH v4] " Robin Jarry
2023-04-14 15:50       ` Robin Jarry
2023-04-14 15:52       ` [PATCH v5] " Robin Jarry
2023-04-20 19:16         ` Robin Jarry [this message]
2023-04-20 19:25           ` Junio C Hamano

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=CS1TOE1MCMH0.2OMA9UHSDG7RC@ringo \
    --to=robin@jarry$(echo .)cc \
    --cc=avarab@gmail$(echo .)com \
    --cc=bagasdotme@gmail$(echo .)com \
    --cc=git@vger$(echo .)kernel.org \
    --cc=gitster@pobox$(echo .)com \
    --cc=michael.strawbridge@amd$(echo .)com \
    --cc=nicolas.dichtel@6wind$(echo .)com \
    --cc=phillip.wood123@gmail$(echo .)com \
    --cc=sunshine@sunshineco$(echo .)com \
    --cc=tim@timculverhouse$(echo .)com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox