Présentation
Chaque paquet doit avoir un fichier manifeste contenant des spécifications qui seront résumées dans la base de données lorsque le paquet sera envoyé sur le serveur. Le manifeste doit être écrit en YAML, en suivant la structure de l’exemple ci-dessous.
Le fichier manifeste doit être nommé manifest.yml et doit se trouver à la racine du paquet (Ne vous inquiétez pas, la commande build de l’outil Yak CLI se charge de cela pour vous !).
L’objectif du manifeste est de favoriser la rationalisation (et potentiellement l’automatisation) du processus de publication des paquets, en évitant de devoir avoir recours à des formulaires Web pour publier des paquets.
Attributs requis
Attributs recommandés
Exemple
Voici un exemple de module de Grasshopper.
name: plankton
version: 0.3.4
authors:
- Daniel Piker
- Will Pearson
description: >
Plankton is a flexible and efficient library for handling n-gonal meshes.
Plankton is written in C# and implements the halfedge data structure. The
structure of the library is loosely based on Rhinocommon's mesh classes and
was originally created for use within C#/VB scripting components in
Grasshopper.
url: "https://github.com/meshmash/Plankton"
Attributs requis
Name
Il s’agit d’un nom court décrivant le paquet. Choisissez de préférence un seul mot ; mais il est aussi possible d’avoir plusieurs mots séparés par des tirets bas ou des tirets intermédiaires.
_Remarque 1 : le nom du paquet ne peut contenir que des lettres, des chiffres, des tirets intermédiaires et des tirets bas.
_Remarque 2 : les noms des paquets prennent la casse utilisée dans la toute première version qui a été téléchargée. Les téléchargements suivants ne tiennent pas compte de la casse du nom du paquet et les requêtes ne tiennent pas compte de la casse.
name: plankton
Version
Depuis la version 0.8 les numéros de version à quatre chiffres sont autorisés.
Depuis la version 0.9 vous pouvez utiliser le caractère générique $version.
C’est le numéro de version attribué au paquet.
Les numéros de version des paquets doivent soit suivre la gestion sémantique de version 2.0.0 (par exemple 1.1.0-beta) ou Système.Version, que l’on appelle aussi norme à quatre chiffres de Microsoft (par exemple 1.2.3.4). Il est recommandé d’utiliser la gestion sémantique de version car cette approche permet aux auteurs de paquets de spécifier des versions préliminaires. C’est pratique pour des essais limités, puisque la dernière version stable est installée par défaut.
Pour faciliter le processus de création, il est possible de remplacer le numéro de version par $version. Le numéro de version sera alors déduit du contenu du paquet et substitué lors du processus de yak build.
version: 0.3.4
Authors
Liste des auteurs du paquet.
authors:
- Daniel Piker
# indiquez les autres auteurs du paquet en dessous
- Will Pearson
Description
Cette section sert à décrire le paquet. À vous de voir si vous souhaitez entrer dans les détails ou être succinct.
description: This is an awesome package.
Si vous souhaitez en écrire davantage, vous pouvez utiliser la structure YAML.
description: >
This is such an awesome package
that I'm going to write a whole
bunch of text describing it!
This sentence will be on a new line.
Attributs recommandés
URL
Site Web pour le paquet. Il peut s’agir de n’importe quelle URL, par exemple les coordonnées de l’auteur, des forums, des tutoriels ou toute autre information sur le module.
url: "https://github.com/meshmash/Plankton"
Keywords
Liste de mots clés qui aideront les utilisateurs à trouver le paquet.
keywords:
- one
- two
Icon
Fichier d’icône dans le paquet. Il doit être de petite taille (par exemple 64x64) et doit être au format PNG ou JPEG.
icon: icon.png
Attributs obsolètes
Icon URL
Lien direct vers une icône qui sera utilisée par le gestionnaire de paquets dans Rhino. Elle doit être de petite taille (32x32 dans l’idéal) et être au format PNG ou JPEG.
icon_url: "https://example.com/path/to/icon.png"
