X-Git-Url: https://git.josue.xyz/?a=blobdiff_plain;f=README.md;h=376623e462d43529322e40c49669c03e5d839f0b;hb=4edf137e5d6b65f9ac847db6694ac387c7e91f3e;hp=c49562f41e787ac52217b13a9cc7988aaa5d833f;hpb=02ac5ea751d51222fa74de40bfbeaa70885d8675;p=webi-installers%2F.git diff --git a/README.md b/README.md index c49562f..376623e 100644 --- a/README.md +++ b/README.md @@ -1,53 +1,69 @@ -# webinstall/packages +# [webi-installers](https://github.com/webinstall/webi-installers) -> WebInstall is how developers install their tools +> [webi](https://webinstall.dev) is how developers install their tools + +[![webinstall-dev-ogimage-github](https://user-images.githubusercontent.com/122831/129465590-136b5a8a-f8f5-4e8d-a010-784eaa9f21bb.png)](https://webinstall.dev) + +- no `sudo` +- no package manager +- no messing with system permissions +- in short: no nonsense + +```bash +curl https://webinstall.dev/webi | bash +``` This repository contains the primary and community-submitted packages for [webinstall.dev](https://webinstall.dev). -# Installer Guidelines - -- Should install to `$HOME/.local/opt/-` or `$HOME/.local/bin` -- Should not need `sudo` (except perhaps for a one-time `setcap`, etc) -- Examples: - - Full Packages: - - Node.js: - - Golang: - - PostgreSQL: - - Single-Binary Installers: - - Caddy: - - Ripgrep: - - Gitea: - - Convenience Scripts: - - Prettier: - - Rust-lang: - - Rust-lang: - -# How it works +# How webi works - Contacts official release APIs for download URLs - Selects the appropriate package version and archive format -- Installs to `$HOME/.local/` +- Installs to `$HOME/.local/opt` or `$HOME/.local/bin`, as appropriate. - Updates `PATH` via `$HOME/.config/envman/PATH.env` - Symlinks or copies current selected version More technically: -1. `/releases.js` transforms the package's release API into a common formatt - - (i.e. HTML, CSV, TAB, or JSON into a specific JSON format) - - common release APIs are in `_common/` (i.e. `_common/github.js`) -2. `_webi/bootstrap.sh` is a template that exchanges system information for a correct installer - - contructs a user agent with os, cpu, and utility info (i.e. `macos`, `amd64`, can unpack `tar,zip,xz`) +1. `/releases.js` transforms the package's release API into a common + format + - (i.e. HTML, CSV, TAB, or JSON into a specific JSON format) + - common release APIs are in `_common/` (i.e. `_common/github.js`) +2. `_webi/bootstrap.sh` is a template that exchanges system information for a + correct installer + - contructs a user agent with os, cpu, and utility info (i.e. `macos`, + `amd64`, can unpack `tar,zip,xz`) 3. `_webi/template.sh` is the base installer template with common functions for - - checking versions - - downloading & unpacking - - updating PATH - - (re-)linking directories + - checking versions + - downloading & unpacking + - updating PATH + - (re-)linking directories 4. `/install.sh` may provide functions to override `_webi/template.sh` 5. Recap: - - `curl https://webinstall.dev/` => `bootstrap-.sh` - - `bash bootstrap-.sh` => `https://webinstall.dev/api/installers/@.sh?formats=zip,tar` - - `bash install-.sh` => download, unpack, move, link, update PATH + - `curl https://webinstall.dev/` => `bootstrap-.sh` + - `bash bootstrap-.sh` => + `https://webinstall.dev/api/installers/@.sh?formats=zip,tar` + - `bash install-.sh` => download, unpack, move, link, update PATH + +# Philosophy (for package authors / maintainers publishing with webi) + +- Should install to `$HOME/.local/opt/-` or `$HOME/.local/bin` +- Should not need `sudo` (except perhaps for a one-time `setcap`, etc) +- Examples: + - Full Packages: + - Node.js: + - Golang: + - PostgreSQL: + - Single-Binary Installers: + - Caddy: + - Ripgrep: + - Gitea: + - Convenience Scripts: + - Prettier: + - Rust-lang: + - vim-sensible: + ## Creating an Installer @@ -55,10 +71,10 @@ An install consists of 5 parts in 4 files: ``` my-new-package/ - - package.yash + - README.md (package info in frontmatter) - releases.js - - install.sh - - install.bat + - install.sh (bash) + - install.ps1 (PowerShell) ``` 1. Create Description @@ -84,11 +100,11 @@ Just create an empty directory and run the tests until you get a good result. ```bash git clone git@github.com:webinstall/packages.git pushd packages +npm install ``` ```bash -mkdir -p new-package -npm install +mkdir -p ./new-package/ node _webi/test.js ./new-package/ ``` @@ -96,27 +112,22 @@ node _webi/test.js ./new-package/ Just copy the format from any of the existing packages. It's like this: -`package.yash`: +`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 -# examples: | -# ```bash -# node -e 'console.log("Hello, World!")' -# > Hello, World! -# ``` - -END -```` - -This is a dumb format. We know. Historical accident (originally these were in -bash comments). +````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 +--- -It's in the TODOs to replace this with either YAML or Markdown. +```bash +node -e 'console.log("Hello, World!")' +> Hello, World! +``` +```` ### 1. Fetch Releases @@ -155,13 +166,13 @@ pkg_cmd_name="foobar" # These are used for symlinks, PATH, and test commands pkg_dst="$HOME/.local/opt/foobar" -pkg_dst_bin="$HOME/.local/opt/foobar/bin" 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_bin="$HOME/.local/opt/foobar-v$WEBI_VERSION/bin" pkg_src_cmd="$HOME/.local/opt/foobar-v$WEBI_VERSION/bin/foobar" +#pkg_src_bin="$(dirname "$pkg_src_cmd")" ``` (required) A version check function that strips all non-version junk @@ -202,9 +213,8 @@ See `webi/template.sh` These variables will be set by the server: -``` +```bash WEBI_PKG=example@v1 -WEBI_NAME=example WEBI_TAG=v1 WEBI_HOST=https://webinstall.dev WEBI_RELEASES=https://webinstall.dev/api/releases/example@v1?os=macos&arch=amd64&pretty=true @@ -220,6 +230,13 @@ WEBI_PKG_URL=https://cdn.example.com/example-macos-amd64.tar.gz WEBI_PKG_FILE=example-macos-amd64.tar.gz ``` +```bash +PKG_NAME=example +PKG_OSES=macos,linux,windows +PKG_ARCHES=amd64,arm64,x86 +PKG_FORMATS=zip,xz +``` + ```bash WEBI_TMP=${WEBI_TMP:-"$(mktemp -d -t webinstall-foobar.XXXXXXXX)"} WEBI_SINGLE="" @@ -227,18 +244,52 @@ WEBI_SINGLE="" ```bash 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/.tar.gz +webi_download # Downloads the selected release to $HOME/Downloads/webi/.tar.gz webi_extract # Extracts the download to /tmp/-/ 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_add_path $pkg_dst_bin` +webi_post_install # Runs `webi_path_add $pkg_dst_bin` ``` # Roadmap - Wrap release APIs to unify and expose +- [ ] Support more Windows packages - [ ] Support arbitrary git urls (i.e. `@github.com/node/node`) - (maybe `ghi node/node` for github specifically) - [ ] Support git as an archive format + +