@orbito/omm (0.1.0)
Installation
@orbito:registry=https://git.kozminski.net.pl/api/packages/orbito/npm/npm install @orbito/omm@0.1.0"@orbito/omm": "0.1.0"About this package
OMM — OrbitoModulesManager
CLI do pakowania i publikacji modułów Orbito na repozytorium modułów
(modules.orbito.pl) — odpowiednik npm publish dla modułów.
Tożsamość paczki (kod modułu i wersja) pochodzi wyłącznie z module.json
w katalogu modułu. Karta modułu musi już istnieć w repozytorium (tworzy się ją
w panelu developera) — pierwsza publikacja nie tworzy modułu automatycznie.
Instalacja
npm i -g @orbito/omm
Paczka jest na razie w prywatnym rejestrze npm (Gitea) — wymagany wpis
w ~/.npmrc (ten sam co dla @orbito/api-lib):
@orbito:registry=https://git.kozminski.net.pl/api/packages/orbito/npm/
//git.kozminski.net.pl/api/packages/orbito/npm/:_authToken=<token>
Wymagany Node.js >= 18.13. Do pracy nad samym CLI: npm install && npm link
w katalogu repo.
Publikacja nowej wersji CLI: podbij version w package.json i npm publish
(rejestr ustawiony w publishConfig).
Użycie
omm login # logowanie hasłem; generuje i zapisuje token publikacji
omm login --token omm_abc... # wariant CI: gotowy token
omm whoami # kto jest zalogowany
omm logout # unieważnia token i usuwa go z konfiguracji
omm pack --dry-run # pokaż, co wejdzie do paczki
omm pack # zbuduj ZIP lokalnie (bez wysyłania)
omm publish # spakuj + wgraj + poczekaj na build Dockera + opublikuj
omm publish --draft # tylko wgraj (wersja zostaje szkicem)
omm publish --changelog "..." # z opisem zmian
Wersję nowej publikacji podbija się edytując pole version w module.json
(musi być semver wyższy niż ostatnio opublikowana wersja).
Konfiguracja
~/.config/omm/config.json— zapisany token publikacji per rejestr (tworzone przezomm login).OMM_TOKEN— token publikacji z env (ma priorytet nad configiem; do CI).OMM_REGISTRY/--registry— adres rejestru (domyślniehttps://modules.orbito.pl).
Co trafia do paczki
Jeśli module.json ma pole files (tablica ścieżek) — tylko wskazane pliki
i katalogi (module.json dołączany zawsze). Bez files — cały katalog modułu
z wyłączeniami: node_modules/, .git/, .env*, .npmrc, *.zip,
make-zip.sh, pliki edytorów.
.npmrc jest wykluczony domyślnie (sekrety w paczce). Jeśli build Dockera
modułu wymaga prywatnych paczek npm, trzeba świadomie dodać --include-npmrc.
Jak działa publikacja
POST /developer/publish— upload ZIP-a; serwer czytamodule.json, sprawdza właściciela karty modułu, semver i kolejkuje build obrazu Dockera. Draft o tej samej wersji jest nadpisywany (retry bez podbijania wersji); wersje opublikowane są niemutowalne.GET /developer/publish/:imageId— CLI odpytuje status builda.POST /developer/publish/:imageId/finalize— publikacja (draft → published); poprzednia opublikowana wersja przechodzi w deprecated.
Autoryzacja: nagłówek Authorization: Bearer omm_... (token publikacji,
zarządzany w panelu developera lub przez omm login/omm logout).
Dependencies
Dependencies
| ID | Version |
|---|---|
| commander | ^12.1.0 |
| yazl | ^2.5.1 |