mktools/doc/tasks/gitea.md
William Petit db7f0ad9db
All checks were successful
Cadoles/mktools/pipeline/head This commit looks good
feat(gitea): add mkt-gitea-package task documentation
2025-04-03 14:16:17 +02:00

47 lines
1.9 KiB
Markdown

# Tâches Gitea
## `make mkt-gitea-release`
La tâche `mkt-gitea-release` permet de créer une "release" sur un projet Gitea et de téléverser des fichiers attachés à celles ci pour qu'ils soient disponibles en téléchargement sur cette version.
### Usage
Exemple d'utilisation de la tâche pour la création d'une nouvelle release sur le projet factice `my-org/my-project` sur https://forge.cadoles.com, tout en attachant les fichiers présents dans le répertoire `dist/`
```makefile
# Organisation Gitea du projet
MKT_GITEA_RELEASE_ORG ?= my-org
# Projet Gitea
MKT_GITEA_RELEASE_PROJECT ?= my-project
# Version associée à la nouvelle release
MKT_GITEA_RELEASE_VERSION ?= v0.0.0
# Texte associé à la release Gitea
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 -printf '%p ')" mkt-gitea-release
```
## `make mkt-gitea-package`
La tâche `mkt-gitea-package` permet de téléverser des paquets (voir https://docs.gitea.com/usage/packages/overview/) dans une organisation Gitea.
### Usage
Exemple d'utilisation de la tâche pour le téléversement de paquets `dist/mypackage.deb` sur le projet factice `my-org/my-project` sur https://forge.cadoles.com.
```makefile
# Organisation Gitea du projet
MKT_GITEA_PACKAGE_ORG ?= my-org
# Projet Gitea
MKT_GITEA_PACKAGE_PROJECT ?= my-project
# Exécution de la tâche mkt-gitea-package en passant le chemin du paquet à téléverser
upload-package:
$(MAKE) MKT_GITEA_PACKAGE_FILE="dist/mypackage.deb" mkt-gitea-package
```
Voir le script [`gitea-package.sh`](https://forge.cadoles.com/Cadoles/Jenkins/src/branch/master/resources/com/cadoles/gitea/gitea-package.sh) pour plus d'informations sur les variables d'environnement disponibles.