Panoramica
Ogni pacchetto dovrebbe avere un file manifesto contenente una specifica che può essere distillata nel database quando il pacchetto viene inviato al server. Il manifesto deve essere scritto in YAML, seguendo la struttura dell’esempio seguente.
Il file manifesto deve essere chiamato manifest.yml e deve trovarsi nella radice del pacchetto. Lo strumento Yak CLI del comando build si occupa di questo aspetto.
Lo scopo del file manifesto è quello di aiutare a semplificare (e potenzialmente automatizzare) il processo di rilascio dei pacchetti, eliminando la necessità di moduli web per la pubblicazione dei pacchetti.
Attributi richiesti
Attributi consigliati
Esempio
Ecco un esempio di plug-in per Grasshopper.
``yaml name: plankton version: 0.3.4 authors:
- Daniel Piker
- Will Pearson descrizione: > 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"
## Attributi richiesti
### Name
Il nome breve che descrive il pacchetto. Preferibilmente un solo mondo, anche se più parole possono essere separate da trattini o trattini bassi.
_**Nota:** Il nome del pacchetto può includere solo lettere, numeri, trattini e trattini bassi.
Nota 2:** I nomi dei pacchetti adottano la distinzione fra maiuscole/minuscole usata nella prima versione caricata. I caricamenti futuri ignorano le maiuscole e le minuscole del nome del pacchetto e tutte le query non sono sensibili a maiuscole/minuscole.
```yaml
name: plankton
Version
Since 0.8: four-digit version numbers allowed
Since 0.9: $version placeholder
Il numero di versione assegnato al pacchetto.
I numeri di versione dei pacchetti devono seguire Semantic Versioning 2.0.0 (ad esempio 1.1.0-beta) o System.Version, ovvero lo standard a quattro cifre di Microsoft (ad esempio 1.2.3.4). Si consiglia di usare il versionamento semantico, perché consente agli autori dei pacchetti di specificare le versioni precedenti al rilascio. Questi sono utili per effettuare test limitati, poiché di default viene installata l’ultima versione stabile.
Per facilitare il processo di creazione, è possibile sostituire il numero di versione con $version - il numero di versione sarà dedotto dal contenuto del pacchetto e sostituito durante yak build.
version: 0.3.4
Authors
Un elenco degli autori del pacchetto.
authors:
- Daniel Piker
# list additional package authors below
- Will Pearson
Description
Descrivere il pacchetto. La descrizione può essere breve o approfondita.
description: This is an awesome package.
Se si vuole scrivere di più, si può usare lo stile folded di YALM.
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.
Attributi consigliati
URL
Una pagina web per il pacchetto. Può trattarsi di qualsiasi URL, ad esempio informazioni di contatto sull’autore, forum, tutorial o qualsiasi altra informazione sul plug-in.
url: "https://github.com/meshmash/Plankton"
Keywords
Un elenco di parole chiave che aiutano gli utenti a trovare il pacchetto.
keywords:
- one
- two
Icon
Un file di icona nel pacchetto. Deve essere piccolo (ad esempio 64x64) e deve essere un PNG o un JPEG.
icon: icon.png
Attributi obsoleti
Icona URL
Specificare un collegamento diretto ad un’icona che verrà usata dal Gestore pacchetti in Rhino. Deve essere piccolo (32x32 sarebbe l’ideale) e deve essere un file PNG o JPEG.
icon_url: "https://example.com/path/to/icon.png"
