webi installers

Webi-Installers

Webi é como os desenvolvedores instalam suas ferramentas

• nenhum sudo
• Nenhum gerente de pacotes
• Sem mexer com as permissões do sistema
• Em suma: sem bobagens

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

Este repositório contém os pacotes primários e submitidos da comunidade para webinstall.dev.

Como funciona o webi

• Contatos APIs oficiais de lançamento para URLs de download
• Seleciona a versão do pacote apropriada e o formato de arquivo
• Instala para $HOME/.local/opt ou $HOME/.local/bin , conforme apropriado.
• Atualiza PATH via $HOME/.config/envman/PATH.env
• Symblinks ou cópias da versão selecionada atual

Mais tecnicamente:

1. <package>/releases.js transforma a API de lançamento do pacote em um formato comum
   • (ou seja, html, csv, tab ou json em um formato json específico)
   • APIs de liberação comum estão em _common/ (ou seja, _common/github.js )
2. _webi/bootstrap.sh é um modelo que troca informações do sistema por um instalador correto
   • Construa um agente de usuário com informações de OS, CPU e utilidade (ou seja, macos , amd64 , pode descompactar tar,zip,xz )
3. _webi/template.sh é o modelo de instalador base com funções comuns para
   • verificando versões
   • Download e descompacagem
   • Caminho de atualização
   • (re) vinculando diretórios
4. <package>/install.sh pode fornecer funções para substituir _webi/template.sh
5. Recapitular:
   • 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 => Download, descompacione, mova, link, caminho de atualização Caminho

Filosofia (para autores de pacotes / mantenedores publicando com webi)

• Deve instalar para $HOME/.local/opt/<package>-<version> ou $HOME/.local/bin
• Não deve precisar de sudo (exceto talvez para um setcap único, etc.)
• Exemplos:
  • Pacotes 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 binários únicos:
    • 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 conveniência:
    • Prettier: https://github.com/webinstall/packages/tree/master/prettier
    • RURS-LANG: https://github.com/webinstall/packages/tree/master/rustlang
    • Vim-sensible: https://github.com/webinstall/packages/tree/master/vim-sensible

Criando um instalador

Uma instalação consiste em 5 partes em 4 arquivos:

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

1. Crie descrição
2. FETCH RELEAÇÕES
3. Verificação de versão (semi-opcional)
4. Caminho de atualização

Veja estes exemplos :

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

O servidor webinstall.dev usa a lista de versões retornadas por <your-package>/releases.js para gerar um script de shell com as variáveis ​​e funções mais necessárias predefinidas.

Você apenas preenche os espaços em branco.

Tl; dr

Basta criar um diretório vazio e executar os testes até obter um bom 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. Crie descrição

Basta copiar o formato de qualquer um dos pacotes existentes. É assim:

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. FETCH LIMENTOS

Tudo o que você está fazendo nesta etapa é apenas traduzir de uma forma de JSON, CSV ou TAB ou qualquer outra coisa, para um formato entendido pela webi .

• Usando lançamentos do GitHub? Consulte ripgrep/releases.js (que usa _common/github.js )
• Tem um formato especial? Consulte golang/releases.js ou node/releases.js .

Parece o seguinte:

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. Variáveis ​​que você pode definir
2. Funções que você deve definir
3. Funções de conveniência / auxiliar

(Opcional, se necessário) Variáveis ​​Bash que você pode 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")"

(NECESSÁRIO) Uma função de verificação de versão que tira todo o lixo não version

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

Para o restante das funções, você pode copiar/colar dos exemplos:

 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

Consulte webi/template.sh

Essas variáveis ​​serão definidas pelo 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`

Roteiro

• Enrole as APIs de liberação para unificar e expor
• Apoie mais pacotes do Windows
• Apoie URLs arbitrários de git (ou seja, @github.com/node/node )
  • (talvez ghi node/node para Github especificamente)
• Apoie o Git como formato de arquivo