webi installers

Webi-Installers

Webi es cómo los desarrolladores instalan sus herramientas

• Sin sudo
• Sin administrador de paquetes
• No se metería con los permisos del sistema
• En resumen: sin tonterías

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

Este repositorio contiene los paquetes primarios y enviados por la comunidad para WebInstall.dev.

Cómo funciona Webi

• Contactos API de lanzamiento oficial para URL de descarga
• Selecciona la versión de paquete apropiada y el formato de archivo
• Instala a $HOME/.local/opt o $HOME/.local/bin , según corresponda.
• PATH de actualizaciones a través de $HOME/.config/envman/PATH.env
• Enlaces simbólicos o copias Versión actual seleccionada

Más técnicamente:

1. <package>/releases.js transforma la API de lanzamiento del paquete en un formato común
   • (es decir, HTML, CSV, TAB o JSON en un formato JSON específico)
   • Las API de lanzamiento comunes están en _common/ (es decir, _common/github.js )
2. _webi/bootstrap.sh es una plantilla que intercambia información del sistema para un instalador correcto
   • Construye un agente de usuario con OS, CPU e información de utilidad (es decir, macos , amd64 , puede desempaquetar tar,zip,xz )
3. _webi/template.sh es la plantilla del instalador base con funciones comunes para
   • versiones de verificación
   • Descargar y desempacar
   • ruta de actualización
   • (re) directorios de vinculación
4. <package>/install.sh puede proporcionar funciones para anular _webi/template.sh
5. Resumen:
   • 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 => descargar, desactivar, mover, enlace, actualizar ruta

Filosofía (para la publicación de autores / mantenedores de paquetes con Webi)

• Debe instalar a $HOME/.local/opt/<package>-<version> o $HOME/.local/bin
• No debería necesitar sudo (excepto quizás para un setcap único, etc.)
• Ejemplos:
  • Paquetes completos:
    • 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
  • Instaladores de una sola binaria:
    • 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 conveniencia:
    • Prettier: 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-sensible

Creando un instalador

Una instalación consta de 5 piezas en 4 archivos:

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

1. Crear descripción
2. Lanzamientos de buscar
3. Verificación de la versión (semi-opcional)
4. Ruta de actualización

Ver estos ejemplos :

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

El servidor webinstall.dev utiliza la lista de lanzamientos devueltos por <your-package>/releases.js para generar un script de shell con la mayoría de las variables y funciones necesarias predefinidas.

Simplemente complete los espacios en blanco.

Tl; Dr

Simplemente cree un directorio vacío y ejecute las pruebas hasta que obtenga un buen resultado.

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. Crear descripción

Simplemente copie el formato de cualquiera de los paquetes existentes. Es así:

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. Lanzamientos de búsqueda

Todo lo que estás haciendo en este paso es solo traducir de una forma de JSON o CSV o TAB o lo que sea, a un formato entendido por webi .

• ¿Usando lanzamientos de GitHub? Ver ripgrep/releases.js (que usa _common/github.js )
• ¿Tienes un formato especial? Ver golang/releases.js o node/releases.js .

Se parece a esto:

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. Instalador BASH

1. Variables que puedes establecer
2. Funciones que debes definir
3. Funciones de conveniencia / ayudante

(Opcional, si es necesario) Variables BASH que puede definir:

 # 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")"

(requerido) Una función de verificación de la versión que elimina toda la basura sin versión

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

Para el resto de las funciones, puede copiar/pegar de los ejemplos:

 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 de script

Ver webi/template.sh

Estas variables serán establecidas por el servidor:

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`

Hoja de ruta

• Envuelva las API de lanzamiento para unificar y exponer
• Admite más paquetes de Windows
• Soporte de URL arbitrarias Git (es decir, @github.com/node/node )
  • (tal vez ghi node/node para GitHub específicamente)
• Apoyar Git como formato de archivo