fix: readme.md
This commit is contained in:
55
README.md
55
README.md
@@ -55,26 +55,34 @@ Prévisualiser le build :
|
|||||||
npm run preview
|
npm run preview
|
||||||
```
|
```
|
||||||
|
|
||||||
### Livraison / publication du layer
|
### Livraison / publication du layer (CI)
|
||||||
|
|
||||||
Vérifier le contenu qui sera publié :
|
La publication est automatique via `.gitea/workflows/release.yml` sur push `main` / `master`.
|
||||||
|
|
||||||
|
Le job CI :
|
||||||
|
|
||||||
|
1. Installe les dépendances
|
||||||
|
2. Lance `npm run dev:prepare`
|
||||||
|
3. Lance `npm run lint`
|
||||||
|
4. Lance `semantic-release` (version automatique + publish sur Gitea Packages)
|
||||||
|
|
||||||
|
Les versions sont calculées via Conventional Commits :
|
||||||
|
|
||||||
|
- `fix: ...` -> patch (`1.0.0` -> `1.0.1`)
|
||||||
|
- `feat: ...` -> minor (`1.0.0` -> `1.1.0`)
|
||||||
|
- `feat!: ...` ou `BREAKING CHANGE:` -> major (`1.0.0` -> `2.0.0`)
|
||||||
|
|
||||||
|
Secrets requis dans le repo Gitea :
|
||||||
|
|
||||||
|
- `NPM_TOKEN` : token avec droits publish package
|
||||||
|
- `RELEASE_TOKEN` : token avec droits write repo (tags/releases)
|
||||||
|
|
||||||
|
Commande locale utile avant push :
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npm pack --dry-run
|
npm pack --dry-run
|
||||||
```
|
```
|
||||||
|
|
||||||
Publier sur le registry NPM configuré :
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npm publish
|
|
||||||
```
|
|
||||||
|
|
||||||
Publier explicitement sur un registry Gitea :
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npm publish --registry https://<gitea-host>/api/packages/<owner>/npm/
|
|
||||||
```
|
|
||||||
|
|
||||||
## Tester un composant dans le playground
|
## Tester un composant dans le playground
|
||||||
|
|
||||||
Le playground étend déjà le layer via `.playground/nuxt.config.ts`.
|
Le playground étend déjà le layer via `.playground/nuxt.config.ts`.
|
||||||
@@ -117,13 +125,28 @@ npm run dev
|
|||||||
|
|
||||||
## Utiliser ce layer dans un autre projet Nuxt
|
## Utiliser ce layer dans un autre projet Nuxt
|
||||||
|
|
||||||
Installer le package :
|
### 1) Configurer le `.npmrc` du projet consommateur
|
||||||
|
|
||||||
|
Option simple :
|
||||||
|
|
||||||
|
```ini
|
||||||
|
@malio:registry=https://gitea.malio.fr/api/packages/MALIO-DEV/npm/
|
||||||
|
```
|
||||||
|
Puis :
|
||||||
|
|
||||||
|
```bash
|
||||||
|
export NPM_TOKEN=TON_TOKEN_GITEA
|
||||||
|
```
|
||||||
|
|
||||||
|
### 2) Installer le package
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npm install @malio/layer-ui
|
npm install @malio/layer-ui
|
||||||
```
|
```
|
||||||
|
|
||||||
Étendre le layer dans `nuxt.config.ts` du projet consommateur :
|
### 3) Étendre le layer
|
||||||
|
|
||||||
|
Dans `nuxt.config.ts` du projet consommateur :
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
export default defineNuxtConfig({
|
export default defineNuxtConfig({
|
||||||
|
|||||||
Reference in New Issue
Block a user