Projects February 2009

projects@lrde.epita.fr

7 participants
4 discussions

by Alexandre Duret-Lutz

Quelques critiques... >>> "VO" == Vincent Ordy <ordy(a)lrde.epita.fr> writes: [...] VO> +# Check 80 columns. VO> +if grep -q '^.\{80,\}' "$file"; then VO> + warning 'Please avoid long lines in your ChangeLog entry (80 columns max):' VO> + grep >&2 '^.\{80,\}' "$file" VO> + error=true VO> +fi 1) Une tabulation devrait compter pour 8 colonnes dans un ChangeLog => il faudrait utiliser "expand" avant grep. 2) Vaucanson contient des noms de fichiers de plus de 80 caractères. Découper un nom de fichier pour le faire tenir sur 80 colonnes ne me paraît pas souhaitable car ça empêche d'utiliser grep ensuite. En fait c'est un cas où il me semble raisonnable de ne pas imposer les 80 colonnes. Peut-être peux-tu ignorer les lignes qui n'ont pas d'espace (de la forme "^\t[^ ]*$") avant de compter les colonnes. VO> +++ b/trunk/git-hooks/post-commit [...] VO> +## Add the log to the ChangeLog VO> +mv "$changelog" "$changelog".old VO> +git > "$changelog" \ VO> + log -n1 --date=short \ VO> + --pretty="format:%ad %an <%ae>%n%n %s%n%n%b%n" VO> +cat >> "$changelog" "$changelog".old VO> +rm "$changelog".old VO> + VO> +## Amend the last commit to add the ChangeLog VO> +git add "$changelog" VO> +tree_ref=$(git write-tree) VO> +commit_ref=$(git log -n1 --pretty="format:%s%n%n%b%n" | \ VO> + git commit-tree $tree_ref -p 'HEAD^') VO> +git update-ref HEAD $commit_ref VO> +git gc --auto Perso il est hors de question que j'utilise un truc pareil. L'intérêt de git est justement que je peux faire plein de commits intermédiaires : certains qui disparaîtront par la suite, d'autres qui seront fusionnés et pour lesquels j'écrirai le ChangeLog plus tard, ou bien des commits que je réordonnerai avant de les rendre publiques. Je ne veux pas que mon ChangeLog soit pollué systématiquement avec ma cuisine. Par hasard est-ce que ce "truc" ne rajouterait pas une entrée de ChangeLog si j'essaye de modifier une typo dans le dernier message de commit avec "commit --amend" ? Non, non, franchement pour éviter le travail de dupliquer les messages des commits et du ChangeLog je vois d'autres solutions : - écrire le ChangeLog confortablement (p.ex. à l'aide de "C-x 4 a" sous emacs) et avoir un script qui appelle "git commit" en lui passant le texte de la dernière entrée. Ça nous permet d'appeler "git commit" normalement pour les commits moins formels. - ne plus écrire de ChangeLog, mais les générer automatiquement juste avant de faire une release (c'est l'approche de GNU Coreutils et de Xorg); ça simplifie les merges. - ne plus écrire de ChangeLog et ne même plus les générer (c'est l'approche de Linux). Pour nous développeurs, les ChangeLogs ne nous servent plus à grand chose à partir du moment où l'on a une copie du dépôt git en local. Mais comme on ne distribue pas le dépôt git en même temps que les sources dans une release, c'est un peu dur de respecter les GPL sans trimbaler de ChangeLog (au moins pour les parties du projets dont nous ne sommes pas propriétaires) : « a) You must cause the modified files to carry prominent notices stating that you changed the files and the date of any change. » -- Alexandre Duret-Lutz

15 years, 7 months

Re: [Projects] 496: git-lrde: Ignore quotes in email address.

by Alexandre Duret-Lutz

>>> "VO" == Vincent Ordy <ordy(a)lrde.epita.fr> writes: VO> trunk/ChangeLog | 8 ++++++++ VO> trunk/src/git-lrde | 1 + C'est curieux, trunk/ n'a rien à faire là. J'imagine que tu as du faire un drôle d'import svn. La commande serait soit: git svn clone -s https://svn.lrde.epita.fr/svn/lrde-tools (pour importer toutes les branches) soit: git svn clone https://svn.lrde.epita.fr/svn/lrde-tools/trunk && mv trunk lrde-tools (pour n'importer qu'une branche) Tu as peux-être tapé la première sans le -s. -- Alexandre Duret-Lutz

15 years, 10 months

496: git-lrde: Ignore quotes in email address.

by Vincent Ordy

Ignore quotes from the email variable :to in the vcs helper file. * trunk/src/git-lrde: here. --- trunk/ChangeLog | 8 ++++++++ trunk/src/git-lrde | 1 + 2 files changed, 9 insertions(+), 0 deletions(-) diff --git a/trunk/ChangeLog b/trunk/ChangeLog index d8f8f7b..f8bac72 100644 --- a/trunk/ChangeLog +++ b/trunk/ChangeLog @@ -1,3 +1,11 @@ +Tue Feb 17 01:48:10 2009 +0100 Vincent Ordy <ordy(a)lrde.epita.fr> + + git-lrde: Ignore quotes in email address. + +Ignore quotes from the email variable :to in the vcs helper file. + + * trunk/src/git-lrde: here. + 2009-02-17 Vincent Ordy <vincent.ordy(a)gmail.com> Add Git hooks. diff --git a/trunk/src/git-lrde b/trunk/src/git-lrde index d46cd77..efb62db 100755 --- a/trunk/src/git-lrde +++ b/trunk/src/git-lrde @@ -119,6 +119,7 @@ lrde_send_email() for f in . .. ../.. ../../..; do test -f "$f"/vcs/*.rb || continue recipient=`sed -n 's/.*mail.*\[$.*@.*$\].*/\1/p' "$f"/vcs/*.rb` + recipient=$(echo "$recipient" | sed "s/['\"]//g") test -z "$recipient" || break done if test -z "$recipient"; then -- 1.5.6.5

15 years, 10 months

495: Add Git hooks.

by Vincent Ordy

They fill: - the default commit message with the modified files list - the ChangeLog with the commit message * trunk/git-hooks/README: New. * trunk/git-hooks/commit-msg: New. * trunk/git-hooks/post-commit: New. * trunk/git-hooks/post-receive: New. * trunk/git-hooks/prepare-commit-msg: New. --- trunk/ChangeLog | 14 ++++++++++ trunk/git-hooks/README | 18 +++++++++++++ trunk/git-hooks/commit-msg | 50 ++++++++++++++++++++++++++++++++++++ trunk/git-hooks/post-commit | 44 +++++++++++++++++++++++++++++++ trunk/git-hooks/post-receive | 11 ++++++++ trunk/git-hooks/prepare-commit-msg | 46 +++++++++++++++++++++++++++++++++ 6 files changed, 183 insertions(+), 0 deletions(-) create mode 100644 trunk/git-hooks/README create mode 100755 trunk/git-hooks/commit-msg create mode 100755 trunk/git-hooks/post-commit create mode 100755 trunk/git-hooks/post-receive create mode 100755 trunk/git-hooks/prepare-commit-msg diff --git a/trunk/ChangeLog b/trunk/ChangeLog index 5ffe38e..d8f8f7b 100644 --- a/trunk/ChangeLog +++ b/trunk/ChangeLog @@ -1,3 +1,17 @@ +2009-02-17 Vincent Ordy <vincent.ordy(a)gmail.com> + + Add Git hooks. + +They fill: +- the default commit message with the modified files list +- the ChangeLog with the commit message + + * trunk/git-hooks/README: New. + * trunk/git-hooks/commit-msg: New. + * trunk/git-hooks/post-commit: New. + * trunk/git-hooks/post-receive: New. + * trunk/git-hooks/prepare-commit-msg: New. + 2008-09-15 Roland Levillain <roland(a)lrde.epita.fr> * src/git-lrde (lrde_dcommit): Be more verbose. diff --git a/trunk/git-hooks/README b/trunk/git-hooks/README new file mode 100644 index 0000000..319b1d5 --- /dev/null +++ b/trunk/git-hooks/README @@ -0,0 +1,18 @@ + README for LRDE git-hooks +--------------------------- + +* How to use: + +- cd to the root of the git repository of your project +- replace the .git/hooks directory with this directory (symbolic link) +- set Git options user.name and user.email with your full name and email + address + + +* What does it do? + +It fills: +- the commit message with the list of new/deleted/modified files +- the ChangeLog with the commit message + +If using Git to track a SVN repository, use git-lrde to commit your patches. diff --git a/trunk/git-hooks/commit-msg b/trunk/git-hooks/commit-msg new file mode 100755 index 0000000..38c4dd7 --- /dev/null +++ b/trunk/git-hooks/commit-msg @@ -0,0 +1,50 @@ +#!/bin/sh + +## Init +set -e +file="$1" +error=false + + +## Functions +stderr() +{ + echo >&2 "$@" +} + +warning() +{ + stderr "warning: $@" +} + + +## Main +# Check commit title. +if head -1 "$file"|grep -q '^\.$'; then + warning 'It looks like you did not fill your commit title.' + error=true +elif head -1 "$file"|grep -q -v '\.'; then + warning 'It looks like your commit title is invalid.' + error=true +fi + +# Check entries. +if grep -q ': \.$' "$file"; then + warning 'It looks like you did not fill all entries in the ChangeLog:' + grep >&2 ': \.$' "$file" + error=true +fi + +# Check 80 columns. +if grep -q '^.\{80,\}' "$file"; then + warning 'Please avoid long lines in your ChangeLog entry (80 columns max):' + grep >&2 '^.\{80,\}' "$file" + error=true +fi + +# Restart editor on error +if $error; then + sleep 2 + "$GIT_EDITOR" "$file" # FIXME: ViM mess the terminal up... + exec "$0" "$@" +fi diff --git a/trunk/git-hooks/post-commit b/trunk/git-hooks/post-commit new file mode 100755 index 0000000..f6b6509 --- /dev/null +++ b/trunk/git-hooks/post-commit @@ -0,0 +1,44 @@ +#!/bin/sh + +## Init +set -e + +## Functions +stderr() +{ + echo >&2 "$@" +} + +warning() +{ + stderr "warning: $@" +} + +## Find the ChangeLog +#FIXME: Try to find the deeper ChangeLog in hierarchy that match all the files +# instead of taking the more generic one. +changelog=$(find -name ChangeLog | \ + awk 'BEGIN { FS="/"; } { print NF-1, $0 }' | \ + sort -k1 | \ + head -1 | \ + sed 's/^[0-9]* $.*$$/\1/') +if test x"$changelog" = x -o ! -f "$changelog"; then + warning 'Your commit will NOT be added to a ChangeLog' + exit 0 +fi + +## Add the log to the ChangeLog +mv "$changelog" "$changelog".old +git > "$changelog" \ + log -n1 --date=short \ + --pretty="format:%ad %an <%ae>%n%n %s%n%n%b%n" +cat >> "$changelog" "$changelog".old +rm "$changelog".old + +## Amend the last commit to add the ChangeLog +git add "$changelog" +tree_ref=$(git write-tree) +commit_ref=$(git log -n1 --pretty="format:%s%n%n%b%n" | \ + git commit-tree $tree_ref -p 'HEAD^') +git update-ref HEAD $commit_ref +git gc --auto diff --git a/trunk/git-hooks/post-receive b/trunk/git-hooks/post-receive new file mode 100755 index 0000000..7ab4c3d --- /dev/null +++ b/trunk/git-hooks/post-receive @@ -0,0 +1,11 @@ +#!/bin/sh + +# Please set: +# * hooks.mailinglist (patches) +# * hooks.announcelist (tags) +# * hooks.envelopesender (EMAIL) +# * hooks.emailprefix (project name) + +# /!\ Does not work with git-svn. + +. /usr/share/doc/git-core/contrib/hooks/post-receive-email diff --git a/trunk/git-hooks/prepare-commit-msg b/trunk/git-hooks/prepare-commit-msg new file mode 100755 index 0000000..c26884e --- /dev/null +++ b/trunk/git-hooks/prepare-commit-msg @@ -0,0 +1,46 @@ +#!/bin/sh + +## Init +set -e +file="$1" +type="$2" + +test x"$type" = x || exit 0 ## not a normal commit message + +## Functions + +# Format the "git st" output +format_filelist() +{ + sed -n -e ' +s/deleted/Remove/g +s/modified//g +s/new file/New/g +s/^# renamed: *$.*$ -> $.*$/ * \1: Rename as...\n * \2: ...this./pg +s/^# $[^:]*$: *$.*$/ * \2: \1./pg +' +} + +# Check whether $1 is set in Git config. +check_var() +{ + if test x"$(git config --get $1 || :)" = x; then + echo >&2 "Please set variable $1 (git config --add $1 value)" + exit 1 + fi +} + +## Main +# Check whether FULLNAME and EMAIL are set and not empty. +check_var user.name +check_var user.email + +# Insert filelist at beginning of commit message +mv "$file" "$file.bak" +cat > "$file" <<EOF +. + +EOF +git-status|format_filelist >> "$file" +cat >> "$file" "$file.bak" +rm "$file.bak" -- 1.5.6.5

15 years, 10 months

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

2010

2009

2008

2007

2006

2005

2004

Projects February 2009