webi installers

webstallers

Webi est comment les développeurs installent leurs outils

• Pas sudo
• Pas de gestionnaire de packages
• Pas de décès avec les autorisations du système
• Bref: pas de non-sens

curl https://webi.sh/webi | sh

Ce référentiel contient les packages principaux et soumis à la communauté pour webinstall.dev.

Comment fonctionne Webi

• Contacte les API de publication officielle pour les URL de téléchargement
• Sélectionne la version et le format d'archives du package approprié
• Installe sur $HOME/.local/opt ou $HOME/.local/bin , selon le cas.
• Mise à jour PATH via $HOME/.config/envman/PATH.env
• Symlinks ou copie la version sélectionnée actuelle

Plus techniquement:

1. <package>/releases.js transforme l'API de libération du package en un format commun
   • (IE HTML, CSV, TAB ou JSON dans un format JSON spécifique)
   • Les API de libération commune sont dans _common/ (c'est-à-dire _common/github.js )
2. _webi/bootstrap.sh est un modèle qui échange les informations système pour un programme d'installation correct
   • Construit un agent utilisateur avec OS, CPU et informations sur les services publics (c'est-à-dire que macos , amd64 , peut déballer tar,zip,xz )
3. _webi/template.sh est le modèle d'installateur de base avec des fonctions communes pour
   • Vérification des versions
   • Téléchargement et déballage
   • Chemin de mise à jour
   • (re) lier les répertoires
4. <package>/install.sh peut fournir des fonctions pour remplacer _webi/template.sh
5. Résumer:
   • curl https://webi.sh/<pkg> => bootstrap-<pkg>.sh
   • sh bootstrap-<pkg>.sh => https://webinstall.dev/api/installers/<pkg>@<ver>.sh?formats=zip,tar
   • sh install-<pkg>.sh => Télécharger, déballer, déplacer, lier, mettre à jour le chemin d'accès

Philosophie (pour les auteurs de packages / mainteneurs publier avec webi)

• Doit installer sur $HOME/.local/opt/<package>-<version> ou $HOME/.local/bin
• Ne devrait pas avoir besoin sudo (sauf peut-être pour un setcap unique, etc.)
• Exemples:
  • Packages complets:
    • Node.js: https://github.com/webinstall/packages/tree/master/node
    • Golang: https://github.com/webinstall/packages/tree/master/golang
    • Postgresql: https://github.com/webinstall/packages/tree/master/postgres
  • Installateurs binaires:: les installateurs binaires:
    • Caddy: https://github.com/webinstall/packages/tree/master/caddy
    • Ripgrep: https://github.com/webinstall/packages/tree/master/ripgrep
    • Gitea: https://github.com/webinstall/packages/tree/master/gitea
  • Scripts de commodité:
    • Plus joli: https://github.com/webinstall/packages/tree/master/prettier
    • Rust-Lang: https://github.com/webinstall/packages/tree/master/rustlang
    • vim-sensible: https://github.com/webinstall/packages/tree/master/vim-senble

Création d'un installateur

Une installation se compose de 5 pièces dans 4 fichiers:

 my-new-package/
  - README.md (package info in frontmatter)
  - releases.js
  - install.sh (POSIX Shell)
  - install.ps1 (PowerShell)

1. Créer une description
2. Reliminaires de récupération
3. Vérification de la version (semi-optionnelle)
4. Mettre à jour le chemin

Voir ces exemples :

• https://github.com/webinstall/packages/blob/master/rg/
• https://github.com/webinstall/packages/blob/master/golang/

Le serveur webinstall.dev utilise la liste des versions renvoyées par <your-package>/releases.js pour générer un script shell avec les variables et fonctions les plus nécessaires prédéfinies.

Vous remplissez simplement les blancs.

Tl; dr

Créez simplement un répertoire vide et exécutez les tests jusqu'à ce que vous obteniez un bon résultat.

git clone [email protected]:webinstall/webi-installers.git
pushd ./webi-installers/
git submodule update --init
npm clean-install

mkdir -p ./new-package/
node _webi/test.js ./new-package/

1. Créer description

Copiez simplement le format à partir de l'un des packages existants. C'est comme ça:

README.md :

 ---
title : Node.js
homepage : https://nodejs.org
tagline : |
  JavaScript V8 runtime
description : |
  Node.js® is a JavaScript runtime built on Chrome's V8 JavaScript engine
---

``` sh
node -e ' console.log("Hello, World!") '
> Hello, World !
```

1. Reliminaires de récupération

Tout ce que vous faites dans cette étape est simplement de traduire d'une forme de JSON ou de CSV ou d'onglet ou autre, vers un format compris par webi .

• En utilisant des versions GitHub? Voir ripgrep/releases.js (qui utilise _common/github.js )
• Vous avez un format spécial? Voir golang/releases.js ou node/releases.js .

Cela ressemble à ceci:

releases.js :

 module . exports = function ( ) {
  return github ( null , owner , repo ) . then ( function ( all ) {
    // if you need to do something special, you can do it here
    // ...
    return all ;
  } ) ;
} ;

2. Installateur de bash

1. Variables que vous pouvez définir
2. Fonctions que vous devez définir
3. Fonctions de commodité / d'assistance

(Facultatif, si nécessaire) Variables bash que vous pouvez définir:

 # Define this if the package name is different from the command name (i.e. golang => go)
pkg_cmd_name= " foobar "

# These are used for symlinks, PATH, and test commands
pkg_dst= " $HOME /.local/opt/foobar "
pkg_dst_cmd= " $HOME /.local/opt/foobar/bin/foobar "
# pkg_dst_bin="$(dirname "$pkg_dst_cmd")"

# These are the _real_ locations for the above
pkg_src= " $HOME /.local/opt/foobar-v $WEBI_VERSION "
pkg_src_cmd= " $HOME /.local/opt/foobar-v $WEBI_VERSION /bin/foobar "
# pkg_src_bin="$(dirname "$pkg_src_cmd")"

(requis) une fonction de vérification de version qui dépouille toutes les ordures non version

 pkg_get_current_version () {
    # foobar-v1.1.7 => 1.1.7
    echo " $( foobar --version | head -n 1 | sed ' s:foobar-v:: ' ) "
}

Pour le reste des fonctions, vous pouvez copier / coller à partir des exemples:

 pkg_format_cmd_version () {}         # Override, pretty prints version

pkg_link                            # Override, replaces webi_link()

pkg_pre_install () {                 # Override, runs any webi_* commands
    webi_check                          # for $HOME/.local/opt tools
    webi_download                       # for things that have a releases.js
    webi_extract                        # for .xz, .tar.*, and .zip files
}

pkg_install () {}                    # Override, usually just needs to rename extracted folder to
                                    # "$HOME/.local/opt/$pkg_cmd_name-v$WEBI_VERSION"

pkg_post_install () {                # Override
    webi_path_add " $pkg_dst_bin "        # should probably update PATH
}

pkg_done_message () {}               # Override, pretty print a success message 

API Script

Voir webi/template.sh

Ces variables seront définies par le serveur:

WEBI_PKG=example@v1
WEBI_TAG=v1
WEBI_HOST=https://webinstall.dev
WEBI_RELEASES=https://webinstall.dev/api/releases/example@v1 ? os=macos & arch=amd64 & pretty=true
WEBI_CSV=v1.0.2,
WEBI_VERSION=1.0.2
WEBI_MAJOR=1
WEBI_MINOR=0
WEBI_PATCH=2
WEBI_LTS=
WEBI_CHANNEL=stable
WEBI_EXT=tar
WEBI_PKG_URL=https://cdn.example.com/example-macos-amd64.tar.gz
WEBI_PKG_FILE=example-macos-amd64.tar.gz

PKG_NAME=example
PKG_OSES=macos,linux,windows
PKG_ARCHES=amd64,arm64,x86
PKG_FORMATS=zip,xz

WEBI_TMP= ${WEBI_TMP :- " $( mktemp -d -t webinstall-foobar.XXXXXXXX ) " }
WEBI_SINGLE= " " 

webi_check              # Checks to see if the selected version is already installed (and re-links if so)
webi_download           # Downloads the selected release to $HOME/Downloads/webi/<package-name>.tar.gz
webi_extract            # Extracts the download to /tmp/<package-name>-<random>/
webi_path_add /new/path # Adds /new/path to PATH for bash, zsh, and fish
webi_pre_install        # Runs webi_check, webi_download, and webi_extract
webi_install            # Moves extracted files from $WEBI_TMP to $pkg_src
webi_link               # replaces any existing symlink with the currently selected version
webi_post_install       # Runs `webi_path_add $pkg_dst_bin`

Feuille de route

• Enveloppez les API de libération pour unifier et exposer
• Prendre en charge plus de packages Windows
• Prise en charge des URL GIT arbitraires (ie @github.com/node/node )
  • (peut-être ghi node/node pour github spécifiquement)
• Soutenez Git comme format d'archives