feat: initial commit

This commit is contained in:
2023-08-21 19:08:40 -06:00
commit cd2f1bad66
7 changed files with 164 additions and 0 deletions

25
doc/tasks/gitea.md Normal file
View File

@ -0,0 +1,25 @@
# 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) mkt-gitea-release
```

24
doc/tasks/webdav.md Normal file
View File

@ -0,0 +1,24 @@
# Tâches WebDAV
## `make mkt-webdav-upload`
La tâche `mkt-webdav-upload` permet de téléverser un fichier sur un espace de partage de fichier proposant une interface WebDAV (Nextcloud par exemple).
### Usage
Exemple d'utilisation de la tâche pour le téléversement d'un fichier `my-doc.txt` généré par une tâche tierce dans le répertoire `my-doc` dans l'espace Nextcloud de l'utilisateur authentifié:
```makefile
# Identifiants de connexion Nextcloud
# Il est conseillé bien entendu de ne pas laisser le mot de passe
# et le nom d'utilisateur "en dur" dans le fichier Makefile...
MKT_WEBDAV_USER ?= my-nextcloud-user
MKT_WEBDAV_PASSWD ?= my-nextcloud-password
# URL de base de l'interface WebDAV de l'espace Nextcloud Cadoles
MKT_WEBDAV_REMOTE_URL = https://nextcloud.cadoles.com/nextcloud/remote.php/dav/files
# Répertoire de destination du fichier à téléverser
MKT_WEBDAV_DIR = /$(MKT_WEBDAV_USER)/my-doc
my-upload:
$(MAKE) MKT_WEBDAV_FILE=test.txt mkt-webdav-upload
```