William Petit
367dbf1883
All checks were successful
Cadoles/mktools/pipeline/head This commit looks good
49 lines
1.5 KiB
Markdown
49 lines
1.5 KiB
Markdown
# MkTools
|
|
|
|
Tâches [Make](https://fr.wikipedia.org/wiki/Make) génériques à utiliser de projet en projet.
|
|
|
|
|
|
|
|
## Utilisation
|
|
|
|
1. Dans le fichier `Makefile` de votre projet, ajouter à la fin de celui ci:
|
|
|
|
```makefile
|
|
build:
|
|
# Votre propre tâche
|
|
|
|
# [...]
|
|
|
|
# Inclure les lignes suivantes:
|
|
|
|
mktools:
|
|
rm -rf .mktools
|
|
curl -q https://forge.cadoles.com/Cadoles/mktools/raw/branch/master/install.sh | $(SHELL)
|
|
|
|
-include .mktools/*.mk
|
|
```
|
|
|
|
2. Synchroniser le répertoire des tâches
|
|
|
|
```shell
|
|
make mktools
|
|
```
|
|
|
|
3. Vous pouvez commencer à utiliser les tâches Make partagées !
|
|
|
|
## Tâches disponibles
|
|
|
|
|Tâches|Description|Documentation|
|
|
|------|-----------|-------------|
|
|
|`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/changelog.md](./doc/tasks/project-version.md)|
|
|
|
|
## Tutoriels
|
|
|
|
- [Créer une "release" avec son fichier `CHANGELOG.md`](./doc/tutorials/generate-release-with-changelog.md)
|
|
|
|
# Changelog
|
|
|
|
[Voir le fichier `CHANGELOG.md`](./CHANGELOG.md) |