docs: extract publication and architecture sections to dedicated files
Move the "Publier le package" section from DEV.md to a new PUBLICATION.md file, and add references to ARCHITECTURE.md and PUBLICATION.md in the main DEV.md index. This reduces the size of DEV.md and improves discoverability by grouping related content into focused documents.
This commit is contained in:
+4
-50
@@ -4,6 +4,10 @@ Ce document couvre les conventions de code, les règles de sécurité et la proc
|
||||
|
||||
Pour les conventions de rédaction : [LANGUE.md](./dev/LANGUE.md) et [REDACTION.md](./dev/REDACTION.md).
|
||||
|
||||
Pour l'architecture partagée (modules, composants, icônes) : [ARCHITECTURE.md](./dev/ARCHITECTURE.md).
|
||||
|
||||
Pour la procédure de publication du package : [PUBLICATION.md](./dev/PUBLICATION.md).
|
||||
|
||||
---
|
||||
|
||||
## Standards de code
|
||||
@@ -53,56 +57,6 @@ STRIPE_SECRET_KEY=...
|
||||
RESEND_API_KEY=...
|
||||
```
|
||||
|
||||
### Dépendances
|
||||
|
||||
Avant chaque publication :
|
||||
|
||||
```bash
|
||||
npm audit
|
||||
```
|
||||
|
||||
Ne pas publier avec des vulnérabilités de sévérité `high` ou `critical` non corrigées.
|
||||
|
||||
### Erreurs exposées
|
||||
|
||||
Les messages d'erreur retournés à l'utilisateur ne contiennent pas de détails internes : pas de stack trace, pas de nom de table, pas de requête SQL. On log côté serveur, on renvoie un message générique côté client.
|
||||
|
||||
---
|
||||
|
||||
## Publier le package
|
||||
|
||||
Le package `@zen/core` est publié sur le registre npm privé à `https://git.hyko.cx`.
|
||||
|
||||
### Configurer l'authentification (une seule fois)
|
||||
|
||||
Créer un token dans Gitea : **Settings → Applications → Generate Token**, puis :
|
||||
|
||||
```bash
|
||||
npm config set //git.hyko.cx/api/packages/zen/npm/:_authToken TOKEN
|
||||
```
|
||||
|
||||
### Checklist avant publication
|
||||
|
||||
- [ ] `npm audit` — aucune vulnérabilité `high` ou `critical`
|
||||
- [ ] `npm run build` — build sans erreur ni warning TypeScript
|
||||
- [ ] Version mise à jour dans `package.json`
|
||||
|
||||
### Versionner
|
||||
|
||||
On suit [semver](https://semver.org) :
|
||||
|
||||
- **patch** (`1.3.x`) — correction de bug, sans changement d'interface
|
||||
- **minor** (`1.x.0`) — nouvelle fonctionnalité, rétrocompatible
|
||||
- **major** (`x.0.0`) — changement cassant
|
||||
|
||||
```bash
|
||||
npm version patch # ou minor, ou major
|
||||
```
|
||||
|
||||
### Publier
|
||||
|
||||
```bash
|
||||
npm publish
|
||||
```
|
||||
|
||||
Le script `prepublishOnly` lance le build automatiquement. Si le build échoue, la publication est annulée.
|
||||
|
||||
Reference in New Issue
Block a user