webi installers

webi-installers

webi เป็นวิธีที่นักพัฒนาติดตั้งเครื่องมือของพวกเขา

• ไม่มี sudo
• ไม่มีผู้จัดการแพ็คเกจ
• ไม่ยุ่งกับการอนุญาตของระบบ
• ในระยะสั้น: ไม่มีเรื่องไร้สาระ

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

พื้นที่เก็บข้อมูลนี้มีแพ็คเกจหลักและชุมชนที่ส่งมาสำหรับ WebInstall.dev

webi ทำงานอย่างไร

• ผู้ติดต่อ API อย่างเป็นทางการสำหรับ URL ดาวน์โหลด
• เลือกเวอร์ชันแพ็คเกจที่เหมาะสมและรูปแบบการเก็บถาวร
• ติดตั้งเป็น $HOME/.local/opt หรือ $HOME/.local/bin ตามความเหมาะสม
• อัปเดต PATH ผ่าน $HOME/.config/envman/PATH.env
• Symlinks หรือคัดลอกเวอร์ชันปัจจุบันที่เลือก

เทคนิคเพิ่มเติม:

1. <package>/releases.js แปลง API ของแพ็คเกจเป็นรูปแบบทั่วไป
   • (เช่น HTML, CSV, TAB หรือ JSON ในรูปแบบ JSON เฉพาะ)
   • APIs ทั่วไปอยู่ใน _common/ (เช่น _common/github.js )
2. _webi/bootstrap.sh เป็นเทมเพลตที่แลกเปลี่ยนข้อมูลระบบสำหรับตัวติดตั้งที่ถูกต้อง
   • สร้างตัวแทนผู้ใช้ด้วย OS, CPU และข้อมูลยูทิลิตี้ (เช่น macos , amd64 , สามารถแกะ tar,zip,xz )
3. _webi/template.sh เป็นเทมเพลตตัวติดตั้งพื้นฐานที่มีฟังก์ชั่นทั่วไปสำหรับ
   • ตรวจสอบเวอร์ชัน
   • การดาวน์โหลดและแกะกล่อง
   • อัปเดตเส้นทาง
   • (อีกครั้ง) การเชื่อมโยงไดเรกทอรี
4. <package>/install.sh อาจให้ฟังก์ชั่นเพื่อแทนที่ _webi/template.sh
5. สรุป:
   • curl https://webi.sh/<pkg> => bootstrap-<pkg>.sh
   • sh bootstrap-<pkg>.sh => https://webinstall.dev/api/installers/<pkg>@<ver>.sh?formats=zip,tar <ver>.sh?formats=zip,tar
   • sh install-<pkg>.sh => ดาวน์โหลด, unpack, ย้าย, ลิงก์, ลิงก์, อัปเดตพา ธ พา ธ

ปรัชญา (สำหรับผู้แต่งแพ็คเกจ / ผู้ดูแลการเผยแพร่ด้วย webi)

• ควรติดตั้งเป็น $HOME/.local/opt/<package>-<version> หรือ $HOME/.local/bin
• ไม่ควรต้องการ sudo (ยกเว้นบางทีสำหรับ setcap ครั้งเดียว ฯลฯ )
• ตัวอย่าง:
  • แพ็คเกจเต็ม:
    • 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
  • ตัวติดตั้งไบนารีเดี่ยว:
    • 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
  • สคริปต์ความสะดวก:
    • 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

การสร้างตัวติดตั้ง

การติดตั้งประกอบด้วย 5 ส่วนใน 4 ไฟล์:

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

1. สร้างคำอธิบาย
2. ดึงออกมา
3. ตรวจสอบเวอร์ชัน (ตัวเลือกกึ่ง)
4. อัปเดตเส้นทาง

ดู ตัวอย่าง เหล่านี้:

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

เซิร์ฟเวอร์ webinstall.dev ใช้รายการรีลีสที่ส่งคืนโดย <your-package>/releases.js เพื่อสร้างเชลล์สคริปต์ที่มีตัวแปรและฟังก์ชั่นที่จำเป็นที่สุดที่กำหนดไว้ล่วงหน้า

คุณเพียงแค่เติมลงในช่องว่าง

tl; dr

เพียงสร้างไดเรกทอรีที่ว่างเปล่าและเรียกใช้การทดสอบจนกว่าคุณจะได้รับผลลัพธ์ที่ดี

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. สร้างคำอธิบาย

เพียงคัดลอกรูปแบบจากแพ็คเกจใด ๆ ที่มีอยู่ มันเป็นเช่นนี้:

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. ดึงออกมา

สิ่งที่คุณทำในขั้นตอนนี้คือการแปลจากรูปแบบหนึ่งของ JSON หรือ CSV หรือแท็บหรืออะไรก็ตามไปยังรูปแบบที่เข้าใจโดย webi

• ใช้ GitHub ปล่อย? ดู ripgrep/releases.js (ซึ่งใช้ _common/github.js )
• มีรูปแบบพิเศษหรือไม่? ดู golang/releases.js หรือ node/releases.js

ดูเหมือนว่า:

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. ตัวติดตั้ง Bash

1. ตัวแปรที่ คุณ สามารถตั้งค่าได้
2. ฟังก์ชั่นที่ คุณ ต้องกำหนด
3. ฟังก์ชั่นความสะดวก / ผู้ช่วย

(ไม่จำเป็นถ้าจำเป็น) ตัวแปร BASH ที่คุณ อาจ กำหนด:

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

(จำเป็น) ฟังก์ชั่นตรวจสอบเวอร์ชันที่แถบขยะที่ไม่ใช่รุ่นทั้งหมด

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

สำหรับฟังก์ชั่นที่เหลือคุณสามารถคัดลอก/วางจากตัวอย่าง:

 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

ดู webi/template.sh

ตัวแปรเหล่านี้จะถูกตั้งค่าโดยเซิร์ฟเวอร์:

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`

แผนงาน

• Wrap Release APIs เพื่อรวมและเปิดเผย
• รองรับแพ็คเกจ Windows เพิ่มเติม
• สนับสนุน URL GIT โดยพลการ (เช่น @github.com/node/node )
  • (บางที ghi node/node สำหรับ GitHub โดยเฉพาะ)
• สนับสนุน Git เป็นรูปแบบการเก็บถาวร