nulib/wip/_rel

568 lines
15 KiB
Plaintext
Raw Normal View History

2025-02-20 10:13:53 +04:00
#!/bin/bash
# -*- coding: utf-8 mode: sh -*- vim:sw=4:sts=4:et:ai:si:sta:fenc=utf-8
source "$(dirname -- "$0")/../load.sh" || exit 1
require: git
2025-02-24 21:38:47 +04:00
git_cleancheckout_DIRTY="\
Vous avez des modifications locales.
Enregistrez ces modifications avant de créer une release"
# configuration par défaut
2025-02-23 18:38:15 +04:00
UPSTREAM=
2025-02-20 10:13:53 +04:00
DEVELOP=develop
FEATURE=wip/
RELEASE=release-
MAIN=master
2025-02-25 12:20:16 +04:00
TAG_PREFIX=
2025-02-23 18:38:15 +04:00
TAG_SUFFIX=
2025-02-20 10:13:53 +04:00
HOTFIX=hotfix-
2025-02-21 04:11:24 +04:00
DIST=
2025-02-24 21:38:47 +04:00
NOAUTO=
2025-02-25 12:20:16 +04:00
function load_branches() {
setx CurrentBranch=git_get_branch
setx -a LocalBranches=git_list_branches
setx -a RemoteBranches=git_list_rbranches "$Origin"
setx -a AllBranches=git_list_pbranches "$Origin"
}
2025-02-24 21:38:47 +04:00
function load_config() {
2025-02-25 12:20:16 +04:00
if [ -n "$ConfigFile" ]; then
source "$ConfigFile" || die
elif [ -n "$ConfigBranch" ]; then
if ! array_contains LocalBranches "$ConfigBranch"; then
die "$ConfigBranch: branche de configuration introuvable"
else
local config="$(git show "$ConfigBranch:.pman.conf" 2>/dev/null)"
[ -n "$config" ] || die "$ConfigBranch: aucune configuration trouvée sur cette branche"
eval "$config"
fi
elif [ -f .pman.conf ]; then
ConfigFile=.pman.conf
source "$ConfigFile"
2025-02-24 21:38:47 +04:00
else
2025-02-25 12:20:16 +04:00
ConfigFile="$MYDIR/pman${MYNAME#_rel}.conf"
source "$ConfigFile"
2025-02-24 21:38:47 +04:00
fi
SrcBranch="$1"
[ -n "$SrcBranch" ] || SrcBranch="$CurrentBranch"
case "$SrcBranch" in
"$UPSTREAM") SrcType=upstream; DestBranch="$DEVELOP";;
"$FEATURE"*) SrcType=feature; DestBranch="$DEVELOP";;
"$DEVELOP") SrcType=develop; DestBranch="$MAIN";;
"$RELEASE"*) SrcType=release; DestBranch="$MAIN";;
"$HOTFIX"*) SrcType=hotfix; DestBranch="$MAIN";;
"$MAIN") SrcType=main; DestBranch="$DIST";;
"$DIST") SrcType=dist; DestBranch=;;
*) DestBranch=;;
esac
}
function ensure_branches() {
[ -n "$SrcBranch" -a -n "$DestBranch" ] ||
die "$SrcBranch: Aucune configuration de fusion trouvée pour cette branche"
2025-02-25 12:20:16 +04:00
array_contains AllBranches "$SrcBranch" || die "$SrcBranch: branche source introuvable"
array_contains AllBranches "$DestBranch" || die "$DestBranch: branche destination introuvable"
2025-02-24 21:38:47 +04:00
local branch
ReleaseBranch=
2025-02-25 12:20:16 +04:00
HotfixBranch=
for branch in "${AllBranches[@]}"; do
2025-02-24 21:38:47 +04:00
if [[ "$branch" == "$RELEASE"* ]]; then
ReleaseBranch="$branch"
2025-02-25 12:20:16 +04:00
elif [[ "$branch" == "$HOTFIX"* ]]; then
HotfixBranch="$branch"
2025-02-24 21:38:47 +04:00
fi
done
}
2025-02-20 10:13:53 +04:00
2025-02-25 12:20:16 +04:00
################################################################################
# Initialisation
################################################################################
2025-02-20 10:13:53 +04:00
function init_action() {
:
}
2025-02-25 12:20:16 +04:00
################################################################################
# Informations
################################################################################
2025-02-24 21:38:47 +04:00
function _filter_rel() {
# enlever les commits "techniques" générés par ce script
grep -v "Intégration de la branche $RELEASE" |
grep -v "Branche $DEVELOP en version .*-SNAPSHOT"
}
function _filter_changes() {
# enlever les commits "inutiles" pour générer le fichier CHANGES.md
grep -vE '^([+|] )?[0-9a-f]+ modifs\.mineures sans commentaires$' |
grep -vE '^([+|] )?[0-9a-f]+ (cosmetic|typo|bug|fix|maj projet|maj deps)\$'
}
function _format_md() {
awk '
$0 == "" || $0 ~ /^#/ { print; next }
$1 == "+" {
$1 = "*"
$2 = "`" $2 "`"
print; next
}
$1 == "|" {
$1 = " *"
$2 = "`" $2 "`"
print; next
}
{
$1 = "* `" $1 "`"
print; next
}
'
}
function _list_commits() {
local source="${1:-$SrcBranch}" dest="${2:-$DestBranch}" mergebase
setx mergebase=git merge-base "$dest" "$source"
git log --oneline --graph "$mergebase..$source" |
grep -vF '|\' | grep -vF '|/' | sed 's/\* //; s/^ /+ /' |
_filter_rel
}
2025-02-25 12:20:16 +04:00
DUMP_VARS=(
ConfigBranch
ConfigFile
--Configuration
UPSTREAM DEVELOP FEATURE RELEASE MAIN TAG_PREFIX TAG_SUFFIX HOTFIX DIST NOAUTO
--Paramètres
CurrentBranch
SrcType SrcBranch
DestBranch
)
function dump_action() {
for var in "${DUMP_VARS[@]}"; do
if [ "${var#--}" != "$var" ]; then
estep "${var#--}"
else
echo_setv "$var=${!var}"
fi
done
}
2025-02-24 21:38:47 +04:00
function show_action() {
local commits
setx commits=_list_commits
if [ -n "$commits" ]; then
einfo "Commits à fusionner $SrcBranch --> $DestBranch"
eecho "$commits"
fi
}
2025-02-25 12:20:16 +04:00
################################################################################
# Fusion de branche
################################################################################
function _mscript_echo() {
echo >>"$script"
echo "$comment$(qvals echo "$@")" >>"$script"
}
function _mscript_add() {
[ $# -gt 0 ] && _mscript_echo "$*"
cat >>"$script"
}
function _mscript_start() {
>"$script"
_mscript_add <<EOF
#!/bin/bash
merge=
push=
for arg in "\$@"; do
case "\$arg" in
merge) merge=1;;
push) push=1;;
esac
done
EOF
chmod +x "$script"
}
2025-02-24 21:38:47 +04:00
function merge_action() {
2025-02-25 12:20:16 +04:00
local script=".git/rel-merge.sh"
local -a push_branches
[ -n "$Merge" ] || exit_with edebug "La fusion est désactivée. Ce script va s'arrêter"
enote "\
Ce script va
- fusionner la branche ${COULEUR_BLEUE}$SrcBranch${COULEUR_NORMALE} dans ${COULEUR_ROUGE}$DestBranch${COULEUR_NORMALE}${Push:+
- pousser les branches modifiées}"
ask_yesno "Voulez-vous continuer?" O || die
local comment=
local or_die=" || exit 1"
_rscript_start
_rscript_add <<EOF
################################################################################
# merge
if [ -n "\$merge" ]; then
EOF
_merge_any_branch "$DestBranch"
_rscript_add <<EOF
fi
EOF
_rscript_add <<EOF
################################################################################
# push
if [ -n "\$push" ]; then
EOF
_push_branches
_rscript_add <<EOF
fi
EOF
if ! "$script" ${Merge:+merge} ${Push:+push}; then
eimportant "Veuillez consulter le script $script pour le détail des opérations qui n'ont pas pu êtres effectuées"
elif [ -z "$_KeepScript" ]; then
rm "$script"
fi
}
function release_upstream_action() {
merge_action "$@"
2025-02-24 21:38:47 +04:00
}
2025-02-25 12:20:16 +04:00
function release_feature_action() {
merge_action "$@"
}
function release_main_action() {
merge_action "$@"
}
function release_dist_action() {
merge_action "$@"
}
################################################################################
# Création et gestion des releases
################################################################################
function _rscript_echo() {
2025-02-24 21:38:47 +04:00
echo >>"$script"
echo "$comment$(qvals echo "$@")" >>"$script"
}
2025-02-25 12:20:16 +04:00
function _rscript_add() {
[ $# -gt 0 ] && _rscript_echo "$*"
2025-02-24 21:38:47 +04:00
cat >>"$script"
}
2025-02-25 12:20:16 +04:00
function _rscript_start() {
2025-02-24 21:38:47 +04:00
>"$script"
2025-02-25 12:20:16 +04:00
_rscript_add <<EOF
2025-02-24 21:38:47 +04:00
#!/bin/bash
2025-02-25 12:20:16 +04:00
create=
merge=
push=
for arg in "\$@"; do
case "\$arg" in
create) create=1;;
merge) merge=1;;
push) push=1;;
esac
done
2025-02-24 21:38:47 +04:00
EOF
chmod +x "$script"
}
function _init_changelog() {
setx date=date +%d/%m/%Y-%H:%M
ac_set_tmpfile changelog
echo >"$changelog" "\
Vérifiez et complétez la liste des changements le cas échéant.
Un fichier vide annule la création de la release
Ces lignes ne seront pas incluses dans le fichier destination
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
"
2025-02-20 10:13:53 +04:00
}
2025-02-24 21:38:47 +04:00
function _create_release_branch() {
local date changelog
_init_changelog
echo >>"$changelog" "\
## Release $Version du $date
"
_list_commits | _filter_changes | _format_md >>"$changelog"
"${EDITOR:-nano}" +7 "$changelog"
[ -s "$changelog" ] || exit_with ewarn "Création de la release annulée"
# créer la branche de release et basculer dessus
2025-02-25 12:20:16 +04:00
_rscript_add "* create branch $ReleaseBranch" <<EOF
2025-02-24 21:38:47 +04:00
$(qvals git checkout -b "$ReleaseBranch" "$SrcBranch")$or_die
EOF
# créer le changelog
2025-02-25 12:20:16 +04:00
_rscript_add "* update CHANGES.md" <<EOF
2025-02-24 21:38:47 +04:00
[ -s CHANGES.md ] && echo >>CHANGES.md
$(qvals echo "$(awk <"$changelog" '
BEGIN { p = 0 }
p == 0 && $0 == "" { p = 1; next }
p == 1 { gsub(/\$/, "\\$", $0); print }
')") >>CHANGES.md
git add CHANGES.md
EOF
# mettre à jour la version
2025-02-25 12:20:16 +04:00
_rscript_add "* update VERSION.txt" <<EOF
2025-02-24 21:38:47 +04:00
$(qvals echo "$Version") >VERSION.txt
git add VERSION.txt
EOF
# Enregistrer les changements
2025-02-25 12:20:16 +04:00
_rscript_add "* commit" <<EOF
2025-02-24 21:38:47 +04:00
$(qvals git commit -m "Init changelog & version $Version")
EOF
}
function _merge_release_branch() {
local dest="$1" tag="$2"
# basculer sur la branche
2025-02-25 12:20:16 +04:00
_rscript_add "* switch to branch $dest" <<EOF
2025-02-24 21:38:47 +04:00
$comment$(qvals git checkout "$dest")$or_die
EOF
# fusionner la branche de release
2025-02-25 12:20:16 +04:00
_rscript_add "* merge branch $ReleaseBranch" <<EOF
2025-02-24 21:38:47 +04:00
$comment$(qvals git merge "$ReleaseBranch" -m "Intégration de la branche $ReleaseBranch" --no-ff)$or_die
EOF
array_addu push_branches "$dest"
# tagger la release
if [ -n "$tag" ]; then
2025-02-25 12:20:16 +04:00
_rscript_add "* create tag $tag" <<EOF
2025-02-24 21:38:47 +04:00
$comment$(qvals git tag --force "$tag")$or_die
EOF
array_addu push_tags "$tag"
fi
}
function _delete_release_branch() {
2025-02-25 12:20:16 +04:00
_rscript_add "* delete branch $ReleaseBranch" <<EOF
2025-02-24 21:38:47 +04:00
$comment$(qvals git branch -D "$ReleaseBranch")$or_die
EOF
}
function _push_branches() {
local origin branch
2025-02-25 12:20:16 +04:00
_rscript_echo "* push branches"
2025-02-24 21:38:47 +04:00
for branch in "${push_branches[@]}"; do
origin="$Origin"
[ -n "$origin" ] || setx origin=git_get_branch_remote "$branch"
[ -n "$origin" ] || origin=origin
setx rbranch=git_get_branch_rbranch "$branch" "$origin"
if [ -n "$rbranch" ]; then
rbranch="${rbranch#refs/remotes/$origin/}"
2025-02-25 12:20:16 +04:00
_rscript_add <<EOF
2025-02-24 21:38:47 +04:00
$comment$(qvals git push "$origin" "$branch:$rbranch")$or_die
EOF
else
2025-02-25 12:20:16 +04:00
_rscript_add <<EOF
2025-02-24 21:38:47 +04:00
$comment$(qvals git push --set-upstream "$origin" "$branch")$or_die
EOF
fi
done
}
function _push_tags() {
local origin tag
2025-02-25 12:20:16 +04:00
_rscript_echo "* push tags"
2025-02-24 21:38:47 +04:00
for tag in "${push_tags[@]}"; do
origin="$Origin"
[ -n "$origin" ] || origin=origin
2025-02-25 12:20:16 +04:00
_rscript_add <<EOF
$comment$(qvals git push --force "$origin" tag "$tag")$or_die
2025-02-24 21:38:47 +04:00
EOF
done
}
function release_develop_action() {
local script=".git/rel-release.sh"
local -a push_branches push_tags
if [ -n "$ReleaseBranch" ]; then
2025-02-25 12:20:16 +04:00
Version="${ReleaseBranch#$RELEASE}"
2025-02-24 21:38:47 +04:00
release_release_action "$@"; return $?
2025-02-25 12:20:16 +04:00
elif [ -n "$HotfixBranch" ]; then
Version="${HotfixBranch#$HOTFIX}"
release_hotfix_action "$@"; return $?
2025-02-24 21:38:47 +04:00
fi
2025-02-25 12:20:16 +04:00
[ -n "$Version" ] || die "Vous devez spécifier la version de la release"
2025-02-24 21:38:47 +04:00
ReleaseBranch="${RELEASE}$Version"
if [ -n "$Merge" ]; then
enote "\
Ce script va:
- créer la branche de release ${COULEUR_VERTE}$ReleaseBranch${COULEUR_NORMALE} <-- ${COULEUR_BLEUE}$SrcBranch${COULEUR_NORMALE}
- la provisionner avec une description des changements
- la fusionner dans la branche destination ${COULEUR_ROUGE}$DestBranch${COULEUR_NORMALE}${Push:+
- pousser les branches modifiées}"
else
enote "\
Ce script va:
- créer la branche de release ${COULEUR_VERTE}$ReleaseBranch${COULEUR_NORMALE} <-- ${COULEUR_BLEUE}$SrcBranch${COULEUR_NORMALE}
- la provisionner avec une description des changements
Vous devrez:
- mettre à jour les informations de release puis relancer ce script"
fi
ask_yesno "Voulez-vous continuer?" O || die
2025-02-25 12:20:16 +04:00
local comment=
local or_die=" || exit 1"
_rscript_start
_rscript_add <<EOF
################################################################################
# create
if [ -n "\$create" ]; then
EOF
2025-02-24 21:38:47 +04:00
_create_release_branch
2025-02-25 12:20:16 +04:00
_rscript_add <<EOF
fi
EOF
_rscript_add <<EOF
################################################################################
# merge
if [ -n "\$merge" ]; then
EOF
_merge_release_branch "$DestBranch" "$TAG_PREFIX$Version$TAG_SUFFIX"
2025-02-24 21:38:47 +04:00
_merge_release_branch "$SrcBranch"
_delete_release_branch
2025-02-25 12:20:16 +04:00
_rscript_add <<EOF
fi
EOF
_rscript_add <<EOF
################################################################################
# push
if [ -n "\$push" ]; then
EOF
2025-02-24 21:38:47 +04:00
_push_branches
_push_tags
2025-02-25 12:20:16 +04:00
_rscript_add <<EOF
fi
EOF
2025-02-24 21:38:47 +04:00
2025-02-25 12:20:16 +04:00
if ! "$script" create ${Merge:+merge} ${Push:+push}; then
2025-02-24 21:38:47 +04:00
eimportant "Veuillez consulter le script $script pour le détail des opérations qui n'ont pas pu êtres effectuées"
2025-02-25 12:20:16 +04:00
elif [ -z "$_KeepScript" ]; then
2025-02-24 21:38:47 +04:00
rm "$script"
fi
}
function release_release_action() {
enote "\
Vous allez:
- fusionner la branche de release ${COULEUR_VERTE}$ReleaseBranch${COULEUR_NORMALE}
dans la branche destination ${COULEUR_ROUGE}$DestBranch${COULEUR_NORMALE}"
ask_yesno "Voulez-vous continuer?" O || die
}
function release_hotfix_action() {
2025-02-25 12:20:16 +04:00
enote "\
Vous allez intégrer la branche de hotfix ${COULEUR_JAUNE}$HotfixBranch${COULEUR_NORMALE}
dans la branche destination ${COULEUR_ROUGE}$DestBranch${COULEUR_NORMALE}"
ask_yesno "Voulez-vous continuer?" O || die
2025-02-24 21:38:47 +04:00
}
2025-02-25 12:20:16 +04:00
################################################################################
# Programme principal
################################################################################
2025-02-20 10:13:53 +04:00
chdir=
2025-02-24 21:38:47 +04:00
Origin=
2025-02-25 12:20:16 +04:00
ConfigBranch=
ConfigFile=
2025-02-24 21:38:47 +04:00
Action=release
Merge=1
Push=1
Version=
2025-02-25 12:20:16 +04:00
_KeepScript=
2025-02-20 10:13:53 +04:00
args=(
2025-02-24 21:38:47 +04:00
"faire une nouvelle release à partir de la branche source"
" -gv VERSION [source]"
2025-02-20 10:13:53 +04:00
-d:,--chdir:BASEDIR chdir= "répertoire dans lequel se placer avant de lancer les opérations"
2025-02-24 21:38:47 +04:00
-o:,--origin Origin= "++\
origine à partir de laquelle les branches distantes sont considérées"
2025-02-25 12:20:16 +04:00
-b:,--config-branch ConfigBranch= "++\
branche à partir de laquelle charger la configuration"
-c:,--config-file:CONFIG ConfigFile= "++\
fichier de configuration des branches. cette option est prioritaire sur --config-branch
par défaut, utiliser le fichier .pman.conf dans le répertoire du dépôt s'il existe"
--keep-script _KeepScript=1 "++option non documentée"
2025-02-24 21:38:47 +04:00
--init Action=init "++\
initialiser les branches $DEVELOP et $MAIN
le nom des branches peut différer si un fichier de configuration est fourni"
2025-02-25 12:20:16 +04:00
--dump-config Action=dump "++\
afficher la configuration chargée"
2025-02-24 21:38:47 +04:00
-s,--show Action=show "\
lister les modifications qui seraient intégrées dans la release"
--release Action=release "créer la release. c'est l'action par défaut"
-k,--no-merge Merge= "\
ne pas fusionner la branche de release après l'avoir créée. implique --no-push"
-m,--merge Merge=1 "++\
fusionner la branche de release après l'avoir créée.
c'est l'option par défaut"
-n,--no-push Push= "\
ne pas pousser les branches vers leur origine après la création de la release"
-p,--push Push=1 "++\
pousser les branches vers leur origine après la création de la release.
c'est l'option par défaut"
-v:,--version Version= "\
spécifier la version de la release à créer"
2025-02-20 10:13:53 +04:00
)
parse_args "$@"; set -- "${args[@]}"
2025-02-24 21:38:47 +04:00
# commencer dans le répertoire indiqué
2025-02-20 10:13:53 +04:00
if [ -n "$chdir" ]; then
cd "$chdir" || die
fi
2025-02-24 21:38:47 +04:00
# se mettre à la racine du dépôt git
git_ensure_gitvcs
setx gitdir=git_get_toplevel
cd "$gitdir" || die
# charger la configuration
2025-02-25 12:20:16 +04:00
load_branches
2025-02-24 21:38:47 +04:00
load_config "$1"
if [ -n "$Merge" -a -n "$NOAUTO" ]; then
ewarn "L'option --no-merge a été forcée puisque ce dépôt ne supporte pas les releases automatiques"
Merge=
fi
[ -z "$Merge" ] && Push=
2025-02-20 10:13:53 +04:00
2025-02-24 21:38:47 +04:00
# puis faire l'action que l'on nous demande
case "$Action" in
2025-02-25 12:20:16 +04:00
init) init_action "$@";;
dump) dump_action "$@";;
2025-02-24 21:38:47 +04:00
show)
git_check_cleancheckout || ewarn "$git_cleancheckout_DIRTY"
ensure_branches
show_action "$@"
;;
2025-02-20 10:13:53 +04:00
release)
2025-02-24 21:38:47 +04:00
git_ensure_cleancheckout
ensure_branches
"release_${SrcType}_action" "$@"
2025-02-20 10:13:53 +04:00
;;
esac