chore: update changelog

.chglog/CHANGELOG.tpl.md

@@ -1,8 +1,8 @@
 {{ if .Versions -}}
+{{ if .Unreleased.CommitGroups -}}
 <a name="unreleased"></a>
 ## [Unreleased]
 
-{{ if .Unreleased.CommitGroups -}}
 {{ range .Unreleased.CommitGroups -}}
 ### {{ .Title }}
 {{ range .Commits -}}
@@ -20,6 +20,8 @@
 {{ range .Commits -}}
 - {{ if .Scope }}**{{ .Scope }}:** {{ end }}{{ .Subject }}
 {{ end }}
+{{ else }}
+_Nothing functionally significant._
 {{ end -}}
 
 {{- if .NoteGroups -}}

CHANGELOG.md

@@ -1,6 +1,72 @@
-<a name="unreleased"></a>
-## [Unreleased]
 
+<a name="2025.1.8-stable.1054.7e5613b"></a>
+## [2025.1.8-stable.1054.7e5613b] - 2025-01-08
+### Bug Fixes
+- typo
+- **install:** correctly inject tools dir into gitignore
+
+### Documentation
+- **tutorials:** fix obsolete link
+
+### Features
+- **gitea:** add mkt-gitea-package task
+- **gitea:** allow passing multiline body/attachments variables
+- **version:** use branch name for short version channel if branch is not a common one
+- **version:** automatically use ci defined branch name
+- **version:** export variables for use in subshells
+
+
+<a name="2023.8.25-stable.1621.af9c7e6"></a>
+## [2023.8.25-stable.1621.af9c7e6] - 2023-08-25
+
+_Nothing functionally significant._
+
+<a name="2023.8.25-stable.1617.35625f6"></a>
+## [2023.8.25-stable.1617.35625f6] - 2023-08-25
+### Documentation
+- add changelog link in readme
+
+### Features
+- **changelog:** display message in changelog when no commit is selected in release
+
+
+<a name="2023.8.25-stable.1609.4d31268"></a>
+## [2023.8.25-stable.1609.4d31268] - 2023-08-25
+
+_Nothing functionally significant._
+
+<a name="2023.8.25-stable.1606.be97e77"></a>
+## [2023.8.25-stable.1606.be97e77] - 2023-08-25
+### Bug Fixes
+- **version:** normalize variable names
+
+### Documentation
+- describe project-version tasks
+
+### Features
+- **changelog:** allow override of command arguments
+- **version:** permit branch name overwrite
+
+
+<a name="2023.8.24-stable.1827.fa2dab5"></a>
+## [2023.8.24-stable.1827.fa2dab5] - 2023-08-24
+
+_Nothing functionally significant._
+
+<a name="2023.8.24-stable.1827.1978504"></a>
+## [2023.8.24-stable.1827.1978504] - 2023-08-24
+### Bug Fixes
+- **install:** add missing tasks in install script
+
+### Features
+- **changelog:** skip unreleased section if no commits are associated
+- **version:** use commit timestamp to generate project version
+
+
+<a name="2023.8.23-stable.1615.1b5c364"></a>
+## [2023.8.23-stable.1615.1b5c364] - 2023-08-23
+
+_Nothing functionally significant._
 
 <a name="2023.8.23-stable.1615.0545812"></a>
 ## [2023.8.23-stable.1615.0545812] - 2023-08-23
@@ -23,5 +89,13 @@
 - initial commit
 
 
-[Unreleased]: https://forge.cadoles.com/Cadoles/mktools/compare/2023.8.23-stable.1615.0545812...HEAD
+[Unreleased]: https://forge.cadoles.com/Cadoles/mktools/compare/2025.1.8-stable.1054.7e5613b...HEAD
+[2025.1.8-stable.1054.7e5613b]: https://forge.cadoles.com/Cadoles/mktools/compare/2023.8.25-stable.1621.af9c7e6...2025.1.8-stable.1054.7e5613b
+[2023.8.25-stable.1621.af9c7e6]: https://forge.cadoles.com/Cadoles/mktools/compare/2023.8.25-stable.1617.35625f6...2023.8.25-stable.1621.af9c7e6
+[2023.8.25-stable.1617.35625f6]: https://forge.cadoles.com/Cadoles/mktools/compare/2023.8.25-stable.1609.4d31268...2023.8.25-stable.1617.35625f6
+[2023.8.25-stable.1609.4d31268]: https://forge.cadoles.com/Cadoles/mktools/compare/2023.8.25-stable.1606.be97e77...2023.8.25-stable.1609.4d31268
+[2023.8.25-stable.1606.be97e77]: https://forge.cadoles.com/Cadoles/mktools/compare/2023.8.24-stable.1827.fa2dab5...2023.8.25-stable.1606.be97e77
+[2023.8.24-stable.1827.fa2dab5]: https://forge.cadoles.com/Cadoles/mktools/compare/2023.8.24-stable.1827.1978504...2023.8.24-stable.1827.fa2dab5
+[2023.8.24-stable.1827.1978504]: https://forge.cadoles.com/Cadoles/mktools/compare/2023.8.23-stable.1615.1b5c364...2023.8.24-stable.1827.1978504
+[2023.8.23-stable.1615.1b5c364]: https://forge.cadoles.com/Cadoles/mktools/compare/2023.8.23-stable.1615.0545812...2023.8.23-stable.1615.1b5c364
 [2023.8.23-stable.1615.0545812]: https://forge.cadoles.com/Cadoles/mktools/compare/2023.8.23-stable.1207.cd2f1ba...2023.8.23-stable.1615.0545812

README.md

@@ -16,7 +16,7 @@ Tâches [Make](https://fr.wikipedia.org/wiki/Make) génériques à utiliser de p
 
     # Inclure les lignes suivantes:
 
-    mktools:
+    .mktools:
     	rm -rf .mktools
     	curl -q https://forge.cadoles.com/Cadoles/mktools/raw/branch/master/install.sh | $(SHELL)
 
@@ -26,7 +26,7 @@ Tâches [Make](https://fr.wikipedia.org/wiki/Make) génériques à utiliser de p
 2. Synchroniser le répertoire des tâches
 
     ```shell
-    make mktools
+    make .mktools
     ```
 
 3. Vous pouvez commencer à utiliser les tâches Make partagées !
@@ -38,7 +38,12 @@ Tâches [Make](https://fr.wikipedia.org/wiki/Make) génériques à utiliser de p
 |`make mkt-webdav-upload`|Téléverser un fichier dans un répertoire WebDAV (Nextcloud)|[Voir ./doc/tasks/webdav.md](./doc/tasks/webdav.md)|
 |`make mkt-gitea-release`|Créer une release sur un projet Gitea et téléverser des fichiers attachés|[Voir ./doc/tasks/gitea.md](./doc/tasks/gitea.md)|
 |`make mkt-changelog`|Générer un fichier de `CHANGELOG.md` pour votre projet|[Voir ./doc/tasks/changelog.md](./doc/tasks/changelog.md)|
+|`make mkt-project-version`|Générer et afficher la version courante du projet|[Voir ./doc/tasks/project-version.md](./doc/tasks/project-version.md)|
 
 ## Tutoriels
 
-- [Créer une "release" avec son fichier `CHANGELOG.md`](./doc/tutorials/generate-release-with-changelog.md)
+- [Créer une "release" avec son fichier `CHANGELOG.md`](./doc/tutorials/generate-release-with-changelog.md)
+
+# Changelog
+
+[Voir le fichier `CHANGELOG.md`](./CHANGELOG.md)

doc/tasks/gitea.md

@@ -21,5 +21,5 @@ MKT_GITEA_RELEASE_BODY ?= My new release
 # Exécution de la tâche mkt-gitea-release en passant la liste
 # des fichiers à téléverser avec la nouvelle version publiée
 my-release:
-	$(MAKE) MKT_GITEA_RELEASE_ATTACHMENTS=$$(find dist/* -type f) mkt-gitea-release
+	$(MAKE) MKT_GITEA_RELEASE_ATTACHMENTS="$$(find dist/* -type f -printf '%p ')" mkt-gitea-release
 ```

doc/tasks/project-version.md

@@ -0,0 +1,13 @@
+# Tâches "Project Version"
+
+## Variables `MKT_PROJECT_VERSION` et `MKT_PROJECT_SHORT_VERSION`
+
+Les variables `MKT_PROJECT_VERSION` et `MKT_PROJECT_SHORT_VERSION` sont automatiquement valuées à la version courante du projet tel que défini dans ["R14. Respecter le schéma d'identification des images publiées"](https://forge.cadoles.com/CadolesKube/KubeRules/wiki/Bonnes-pratiques-de-d%C3%A9veloppement-applicatif-en-vue-d%27un-d%C3%A9ploiement-sur-Kubernetes#r14-respecter-le-sch%C3%A9ma-d-identification-des-images-publi%C3%A9es).
+
+## `make mkt-project-version`
+
+La tâche `make mkt-project-version` affiche sur la sortie standard la version courante du projet.
+
+## `make mkt-project-short-version`
+
+La tâche `make mkt-project-short-version` affiche sur la sortie standard la version courte courante du projet.

doc/tutorials/generate-release-with-changelog.md

@@ -1,6 +1,6 @@
 # Générer une release pour son projet
 
-Afin de générer une release pour votre projet (exemple: https://forge.cadoles.com/Cadoles/mktools/releases/tag/2023.8.23-stable.1545.643e170) ainsi que le fichier `CHANGELOG.md` associé à votre historique Git, vous pouvez intégrer à votre `Makefile` les tâches suivantes:
+Afin de générer une release pour votre projet ([exemples](https://forge.cadoles.com/Cadoles/mktools/releases)) ainsi que le fichier `CHANGELOG.md` associé à votre historique Git, vous pouvez intégrer à votre `Makefile` les tâches suivantes:
 
 ```makefile
 MKT_GITEA_RELEASE_ORG ?= MyOrg              # Propriétaire (organisation ou utilsateur) du projet Gitea

install.sh

@@ -3,7 +3,7 @@
 set -e
 
 TASKS_DIR=".mktools"
-TASKS_FILES="webdav gitea changelog version checkmake"
+TASKS="${TASKS:-webdav gitea changelog version checkmake}"
 
 main() {
     echo "Creating directory '$TASKS_DIR/'"
@@ -11,7 +11,7 @@ main() {
     mkdir -p "$TASKS_DIR"
 
     # Download each referenced task files in $TASKS_DIR
-    for f in $TASKS_FILES; do
+    for f in $TASKS; do
         echo "Downloading file '$TASKS_DIR/$f.mk'"
         curl -qo "$TASKS_DIR/$f.mk" "https://forge.cadoles.com/Cadoles/mktools/raw/branch/master/tasks/$f.mk"
     done
@@ -20,7 +20,7 @@ main() {
     if [ ! -f .gitignore ]; then
         touch .gitignore
     fi
-    grep -qF -- "$TASKS_DIR/" ".gitignore" || echo "$TASKS_DIR/" >> ".gitignore"
+    grep -qFx -- "$TASKS_DIR/" .gitignore || echo -e "$TASKS_DIR/" >> .gitignore
 
     echo "Done"
 }

tasks/changelog.mk

@@ -1,6 +1,6 @@
 MKT_GIT_CHGLOG_VERSION ?= 0.15.4
 MKT_GIT_CHGLOG_DOWNLOAD_URL ?= https://github.com/git-chglog/git-chglog/releases/download/v$(MKT_GIT_CHGLOG_VERSION)/git-chglog_$(MKT_GIT_CHGLOG_VERSION)_linux_amd64.tar.gz
-MKT_GIT_CHGLOG_ARGS ?=
+MKT_GIT_CHGLOG_ARGS ?= --output CHANGELOG.md
 MKT_GIT_CHGLOG_PROJECT_ORG ?= 
 export MKT_GIT_CHGLOG_PROJECT_ORG
 MKT_GIT_CHGLOG_PROJECT_NAME ?= 
@@ -71,6 +71,8 @@ cat > .chglog/CHANGELOG.tpl.md << EOF
 {{ range .Commits -}}
 - {{ if .Scope }}**{{ .Scope }}:** {{ end }}{{ .Subject }}
 {{ end }}
+{{ else }}
+_Nothing functionally significant._
 {{ end -}}
 
 {{- if .NoteGroups -}}
@@ -96,7 +98,7 @@ endef
 export MKT_GIT_CHGLOG_TEMPLATE_SCRIPT = $(value _MKT_GIT_CHGLOG_TEMPLATE_SCRIPT)
 
 mkt-changelog: tools/git-chglog/bin/git-chglog .chglog/config.yml .chglog/CHANGELOG.tpl.md
-	tools/git-chglog/bin/git-chglog --output CHANGELOG.md $(MKT_GIT_CHGLOG_ARGS)
+	tools/git-chglog/bin/git-chglog $(MKT_GIT_CHGLOG_ARGS)
 
 .chglog/config.yml:
 	@eval "$$MKT_GIT_CHGLOG_CONFIG_SCRIPT"

tasks/gitea.mk

@@ -9,6 +9,16 @@ MKT_GITEA_RELEASE_ATTACHMENTS ?=
 MKT_GITEA_RELEASE_USERNAME ?=
 MKT_GITEA_RELEASE_PASSWORD ?=
 
+define GITEA_RELEASE_BODY
+$(MKT_GITEA_RELEASE_BODY)
+endef
+export GITEA_RELEASE_BODY
+
+define GITEA_RELEASE_ATTACHMENTS
+$(MKT_GITEA_RELEASE_ATTACHMENTS)
+endef
+export GITEA_RELEASE_ATTACHMENTS
+
 mkt-gitea-release: tools/gitea-release/bin/gitea-release.sh
 	GITEA_RELEASE_PROJECT="$(MKT_GITEA_RELEASE_PROJECT)" \
 		GITEA_RELEASE_ORG="$(MKT_GITEA_RELEASE_ORG)" \
@@ -17,8 +27,6 @@ mkt-gitea-release: tools/gitea-release/bin/gitea-release.sh
 		GITEA_RELEASE_NAME="$(MKT_GITEA_RELEASE_VERSION)" \
 		GITEA_RELEASE_COMMITISH_TARGET="$(MKT_GITEA_RELEASE_COMMIT_TARGET)" \
 		GITEA_RELEASE_IS_DRAFT="$(MKT_GITEA_RELEASE_IS_DRAFT)" \
-		GITEA_RELEASE_BODY="$(MKT_GITEA_RELEASE_BODY)" \
-		GITEA_RELEASE_ATTACHMENTS="$(MKT_GITEA_RELEASE_ATTACHMENTS)" \
 		GITEA_RELEASE_USERNAME="$(MKT_GITEA_RELEASE_USERNAME)" \
 		GITEA_RELEASE_PASSWORD="$(MKT_GITEA_RELEASE_PASSWORD)" \
 		tools/gitea-release/bin/gitea-release.sh
@@ -27,4 +35,26 @@ tools/gitea-release/bin/gitea-release.sh:
 	mkdir -p tools/gitea-release/bin
 	curl --output tools/gitea-release/bin/gitea-release.sh https://forge.cadoles.com/Cadoles/Jenkins/raw/branch/master/resources/com/cadoles/gitea/gitea-release.sh
 	chmod +x tools/gitea-release/bin/gitea-release.sh
+	grep -qF -- "tools/" ".gitignore" 2>/dev/null || echo "tools/" >> ".gitignore"
+
+
+MKT_GITEA_PACKAGE_PROJECT ?=
+MKT_GITEA_PACKAGE_ORG ?=
+MKT_GITEA_PACKAGE_BASE_URL ?= https://forge.cadoles.com
+MKT_GITEA_PACKAGE_USERNAME ?=
+MKT_GITEA_PACKAGE_USERNAME ?=
+
+mkt-gitea-package: tools/gitea-package/bin/gitea-package.sh
+	GITEA_PACKAGE_PROJECT="$(MKT_GITEA_PACKAGE_PROJECT)" \
+		GITEA_PACKAGE_ORG="$(MKT_GITEA_PACKAGE_ORG)" \
+		GITEA_PACKAGE_BASE_URL="$(MKT_GITEA_PACKAGE_BASE_URL)" \
+		GITEA_PACKAGE_FILE="$(MKT_GITEA_PACKAGE_FILE)" \
+		GITEA_PACKAGE_USERNAME="$(MKT_GITEA_PACKAGE_USERNAME)" \
+		GITEA_PACKAGE_PASSWORD="$(MKT_GITEA_PACKAGE_PASSWORD)" \
+		tools/gitea-package/bin/gitea-package.sh
+
+tools/gitea-package/bin/gitea-package.sh:
+	mkdir -p tools/gitea-package/bin
+	curl --output tools/gitea-package/bin/gitea-package.sh https://forge.cadoles.com/Cadoles/Jenkins/raw/branch/master/resources/com/cadoles/gitea/gitea-package.sh
+	chmod +x tools/gitea-package/bin/gitea-package.sh
 	grep -qF -- "tools/" ".gitignore" 2>/dev/null || echo "tools/" >> ".gitignore"

tasks/version.mk

@@ -1,11 +1,13 @@
-MKT_PROJECT_BRANCH_NAME ?= $(shell git rev-parse --abbrev-ref HEAD | tr '[:upper:]' '[:lower:]' | sed -e 's/[-_ ]//g')
+MKT_PROJECT_VERSION_TIMEZONE ?= Europe/Paris
+MKT_PROJECT_VERSION_BRANCH_NAME ?= $(if $(CI), $(BRANCH_NAME), $(shell git rev-parse --abbrev-ref HEAD))
+MKT_PROJECT_VERSION_CLEANED_BRANCH_NAME ?= $(shell echo $(MKT_PROJECT_VERSION_BRANCH_NAME) | tr '[:upper:]' '[:lower:]' | sed -e 's/[-_ ]//g')
 
-ifeq ($(MKT_PROJECT_BRANCH_NAME),master)
+ifeq ($(MKT_PROJECT_VERSION_CLEANED_BRANCH_NAME),master)
     MKT_PROJECT_VERSION_CHANNEL = stable
-else ifeq ($(MKT_PROJECT_BRANCH_NAME),staging)
+else ifeq ($(MKT_PROJECT_VERSION_CLEANED_BRANCH_NAME),staging)
 	MKT_PROJECT_VERSION_CHANNEL = testing
 else
-	MKT_PROJECT_VERSION_CHANNEL = $(MKT_PROJECT_BRANCH_NAME)
+	MKT_PROJECT_VERSION_CHANNEL = $(MKT_PROJECT_VERSION_CLEANED_BRANCH_NAME)
 endif
 
 
@@ -16,15 +18,18 @@ else ifneq ($(filter $(MKT_PROJECT_VERSION_CHANNEL),testing staging),)
 else ifneq ($(filter $(MKT_PROJECT_VERSION_CHANNEL),stable master),)
 	MKT_PROJECT_SHORT_VERSION_CHANNEL ?= stb
 else
-	MKT_PROJECT_SHORT_VERSION_CHANNEL ?= $(shell echo "$(MKT_PROJECT_VERSION_CHANNEL)" | sed -e 's/[aeiouy]//g' | cut -c1-3)
+	MKT_PROJECT_SHORT_VERSION_CHANNEL ?= $(MKT_PROJECT_VERSION_CHANNEL)
 endif
 
 MKT_PROJECT_VERSION_COMMIT_TIMESTAMP ?= $(shell git show -s --format=%ct)
-MKT_PROJECT_VERSION_DATE ?= $(shell TZ=Europe/Paris date -d '@$(MKT_PROJECT_VERSION_COMMIT_TIMESTAMP)' +%Y.%-m.%-d)
+MKT_PROJECT_VERSION_DATE ?= $(shell TZ=$(MKT_PROJECT_VERSION_TIMEZONE) date -d '@$(MKT_PROJECT_VERSION_COMMIT_TIMESTAMP)' +%Y.%-m.%-d)
-MKT_PROJECT_VERSION_TIMESTAMP ?= $(shell TZ=Europe/Paris date -d '@$(MKT_PROJECT_VERSION_COMMIT_TIMESTAMP)' +%-H%M)
+MKT_PROJECT_VERSION_TIMESTAMP ?= $(shell TZ=$(MKT_PROJECT_VERSION_TIMEZONE) date -d '@$(MKT_PROJECT_VERSION_COMMIT_TIMESTAMP)' +%-H%M)
 
-MKT_PROJECT_VERSION ?= $(MKT_PROJECT_VERSION_DATE)-$(MKT_PROJECT_VERSION_CHANNEL).$(MKT_PROJECT_VERSION_TIMESTAMP).$(shell git rev-parse --short HEAD)
+MKT_PROJECT_VERSION := $(MKT_PROJECT_VERSION_DATE)-$(MKT_PROJECT_VERSION_CHANNEL).$(MKT_PROJECT_VERSION_TIMESTAMP).$(shell git rev-parse --short HEAD)
-MKT_PROJECT_SHORT_VERSION ?= $(MKT_PROJECT_VERSION_DATE)-$(MKT_PROJECT_SHORT_VERSION_CHANNEL).$(MKT_PROJECT_VERSION_TIMESTAMP)
+MKT_PROJECT_SHORT_VERSION := $(MKT_PROJECT_VERSION_DATE)-$(MKT_PROJECT_SHORT_VERSION_CHANNEL).$(MKT_PROJECT_VERSION_TIMESTAMP)
+
+export MKT_PROJECT_VERSION
+export MKT_PROJECT_SHORT_VERSION
 
 .PHONY: mkt-project-version
 mkt-project-version: