A v-tag releases Luxe with installers, Homebrew and crates.io, SECURITY.md says how to report a hole, and luxe update runs the installer's updater
- release.yml, generated by dist from dist-workspace.toml, builds macOS, Linux and Windows, attests every artifact, and publishes shell and PowerShell installers with their updater, a luxe formula in evanwhittaker/homebrew-tap, and the crates through Trusted Publishing (publish-crates.yml, which skips versions crates.io already has). - luxe update recognizes an installer copy by luxe-cli-update beside it and runs that. - The README, the install guide and the site lead with the installer, Homebrew and Windows. - SECURITY.md: report privately through a GitHub advisory or contact@luxe.dev.
This commit is contained in:
68
.github/workflows/publish-crates.yml
vendored
Normal file
68
.github/workflows/publish-crates.yml
vendored
Normal file
@@ -0,0 +1,68 @@
|
||||
# Publish crates — the release's crates go to crates.io.
|
||||
#
|
||||
# A dist custom publish job (`publish-jobs` in dist-workspace.toml): release.yml calls it once the
|
||||
# GitHub release hosts the artifacts, and announces only after it succeeds.
|
||||
#
|
||||
# No token is stored. crates.io Trusted Publishing trusts the OIDC token GitHub mints for the run,
|
||||
# and it matches the *calling* workflow, so each crate's trusted publisher names `release.yml`,
|
||||
# not this file.
|
||||
#
|
||||
# A crate whose version crates.io already has is skipped, so a re-run after a partial publish, or
|
||||
# a release whose crates were published by hand first, carries on rather than failing announce.
|
||||
name: Publish crates
|
||||
|
||||
on:
|
||||
workflow_call:
|
||||
inputs:
|
||||
plan:
|
||||
required: true
|
||||
type: string
|
||||
|
||||
permissions: {}
|
||||
|
||||
jobs:
|
||||
publish:
|
||||
name: publish to crates.io
|
||||
# A tag pushed to the development repository must never publish; skipped, announce still runs
|
||||
if: github.repository == 'evanwhittaker/luxe'
|
||||
runs-on: ubuntu-latest
|
||||
timeout-minutes: 45
|
||||
permissions:
|
||||
contents: read
|
||||
id-token: write
|
||||
steps:
|
||||
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
|
||||
|
||||
- uses: dtolnay/rust-toolchain@4cda84d5c5c54efe2404f9d843567869ab1699d4 # stable
|
||||
|
||||
- name: Which crates crates.io still needs
|
||||
id: pending
|
||||
shell: bash
|
||||
run: |
|
||||
exclude=""
|
||||
pending=0
|
||||
while read -r name version; do
|
||||
status=$(curl -s -o /dev/null -w '%{http_code}' -A 'luxe release (github.com/evanwhittaker/luxe)' \
|
||||
"https://crates.io/api/v1/crates/$name/$version")
|
||||
case "$status" in
|
||||
200) echo "$name $version is already published"; exclude="$exclude --exclude $name" ;;
|
||||
404) echo "$name $version will be published"; pending=$((pending + 1)) ;;
|
||||
*) echo "crates.io answered $status for $name $version" >&2; exit 1 ;;
|
||||
esac
|
||||
done < <(cargo metadata --no-deps --format-version 1 \
|
||||
| jq -r '.packages[] | select(.publish == null or (.publish | length > 0)) | "\(.name) \(.version)"')
|
||||
echo "exclude=$exclude" >> "$GITHUB_OUTPUT"
|
||||
echo "count=$pending" >> "$GITHUB_OUTPUT"
|
||||
|
||||
- name: Trusted Publishing token
|
||||
if: steps.pending.outputs.count != '0'
|
||||
id: auth
|
||||
uses: rust-lang/crates-io-auth-action@c6f97d42243bad5fab37ca0427f495c86d5b1a18 # v1.0.5
|
||||
|
||||
# Dependencies first, which `--workspace` orders for us
|
||||
- name: Publish
|
||||
if: steps.pending.outputs.count != '0'
|
||||
run: cargo publish --workspace --locked $EXCLUDE
|
||||
env:
|
||||
EXCLUDE: ${{ steps.pending.outputs.exclude }}
|
||||
CARGO_REGISTRY_TOKEN: ${{ steps.auth.outputs.token }}
|
||||
366
.github/workflows/release.yml
vendored
Normal file
366
.github/workflows/release.yml
vendored
Normal file
@@ -0,0 +1,366 @@
|
||||
# This file was autogenerated by dist: https://axodotdev.github.io/cargo-dist
|
||||
#
|
||||
# Copyright 2022-2024, axodotdev
|
||||
# SPDX-License-Identifier: MIT or Apache-2.0
|
||||
#
|
||||
# CI that:
|
||||
#
|
||||
# * checks for a Git Tag that looks like a release
|
||||
# * builds artifacts with dist (archives, installers, hashes)
|
||||
# * uploads those artifacts to temporary workflow zip
|
||||
# * on success, uploads the artifacts to a GitHub Release
|
||||
#
|
||||
# Note that the GitHub Release will be created with a generated
|
||||
# title/body based on your changelogs.
|
||||
|
||||
name: Release
|
||||
permissions:
|
||||
"contents": "write"
|
||||
|
||||
# This task will run whenever you push a git tag that looks like a version
|
||||
# like "1.0.0", "v0.1.0-prerelease.1", "my-app/0.1.0", "releases/v1.0.0", etc.
|
||||
# Various formats will be parsed into a VERSION and an optional PACKAGE_NAME, where
|
||||
# PACKAGE_NAME must be the name of a Cargo package in your workspace, and VERSION
|
||||
# must be a Cargo-style SemVer Version (must have at least major.minor.patch).
|
||||
#
|
||||
# If PACKAGE_NAME is specified, then the announcement will be for that
|
||||
# package (erroring out if it doesn't have the given version or isn't dist-able).
|
||||
#
|
||||
# If PACKAGE_NAME isn't specified, then the announcement will be for all
|
||||
# (dist-able) packages in the workspace with that version (this mode is
|
||||
# intended for workspaces with only one dist-able package, or with all dist-able
|
||||
# packages versioned/released in lockstep).
|
||||
#
|
||||
# If you push multiple tags at once, separate instances of this workflow will
|
||||
# spin up, creating an independent announcement for each one. However, GitHub
|
||||
# will hard limit this to 3 tags per commit, as it will assume more tags is a
|
||||
# mistake.
|
||||
#
|
||||
# If there's a prerelease-style suffix to the version, then the release(s)
|
||||
# will be marked as a prerelease.
|
||||
on:
|
||||
pull_request:
|
||||
push:
|
||||
tags:
|
||||
- '**[0-9]+.[0-9]+.[0-9]+*'
|
||||
|
||||
jobs:
|
||||
# Run 'dist plan' (or host) to determine what tasks we need to do
|
||||
plan:
|
||||
runs-on: "ubuntu-22.04"
|
||||
outputs:
|
||||
val: ${{ steps.plan.outputs.manifest }}
|
||||
tag: ${{ !github.event.pull_request && github.ref_name || '' }}
|
||||
tag-flag: ${{ !github.event.pull_request && format('--tag={0}', github.ref_name) || '' }}
|
||||
publishing: ${{ !github.event.pull_request }}
|
||||
env:
|
||||
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
steps:
|
||||
- uses: actions/checkout@d23441a48e516b6c34aea4fa41551a30e30af803
|
||||
with:
|
||||
persist-credentials: false
|
||||
submodules: recursive
|
||||
- name: Install dist
|
||||
# we specify bash to get pipefail; it guards against the `curl` command
|
||||
# failing. otherwise `sh` won't catch that `curl` returned non-0
|
||||
shell: bash
|
||||
run: "curl --proto '=https' --tlsv1.2 -LsSf https://github.com/axodotdev/cargo-dist/releases/download/v0.33.0/cargo-dist-installer.sh | sh"
|
||||
- name: Cache dist
|
||||
uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9
|
||||
with:
|
||||
name: cargo-dist-cache
|
||||
path: ~/.cargo/bin/dist
|
||||
# sure would be cool if github gave us proper conditionals...
|
||||
# so here's a doubly-nested ternary-via-truthiness to try to provide the best possible
|
||||
# functionality based on whether this is a pull_request, and whether it's from a fork.
|
||||
# (PRs run on the *source* but secrets are usually on the *target* -- that's *good*
|
||||
# but also really annoying to build CI around when it needs secrets to work right.)
|
||||
- id: plan
|
||||
run: |
|
||||
dist ${{ (!github.event.pull_request && format('host --steps=create --tag={0}', github.ref_name)) || 'plan' }} --output-format=json > plan-dist-manifest.json
|
||||
echo "dist ran successfully"
|
||||
cat plan-dist-manifest.json
|
||||
echo "manifest=$(jq -c "." plan-dist-manifest.json)" >> "$GITHUB_OUTPUT"
|
||||
- name: "Upload dist-manifest.json"
|
||||
uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9
|
||||
with:
|
||||
name: artifacts-plan-dist-manifest
|
||||
path: plan-dist-manifest.json
|
||||
|
||||
# Build and packages all the platform-specific things
|
||||
build-local-artifacts:
|
||||
name: build-local-artifacts (${{ join(matrix.targets, ', ') }})
|
||||
# Let the initial task tell us to not run (currently very blunt)
|
||||
needs:
|
||||
- plan
|
||||
if: ${{ fromJson(needs.plan.outputs.val).ci.github.artifacts_matrix.include != null && (needs.plan.outputs.publishing == 'true' || fromJson(needs.plan.outputs.val).ci.github.pr_run_mode == 'upload') }}
|
||||
strategy:
|
||||
fail-fast: false
|
||||
# Target platforms/runners are computed by dist in create-release.
|
||||
# Each member of the matrix has the following arguments:
|
||||
#
|
||||
# - runner: the github runner
|
||||
# - dist-args: cli flags to pass to dist
|
||||
# - install-dist: expression to run to install dist on the runner
|
||||
#
|
||||
# Typically there will be:
|
||||
# - 1 "global" task that builds universal installers
|
||||
# - N "local" tasks that build each platform's binaries and platform-specific installers
|
||||
matrix: ${{ fromJson(needs.plan.outputs.val).ci.github.artifacts_matrix }}
|
||||
runs-on: ${{ matrix.runner }}
|
||||
container: ${{ matrix.container && matrix.container.image || null }}
|
||||
env:
|
||||
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
BUILD_MANIFEST_NAME: target/distrib/${{ join(matrix.targets, '-') }}-dist-manifest.json
|
||||
permissions:
|
||||
"attestations": "write"
|
||||
"contents": "read"
|
||||
"id-token": "write"
|
||||
steps:
|
||||
- name: enable windows longpaths
|
||||
run: |
|
||||
git config --global core.longpaths true
|
||||
- uses: actions/checkout@d23441a48e516b6c34aea4fa41551a30e30af803
|
||||
with:
|
||||
persist-credentials: false
|
||||
submodules: recursive
|
||||
- name: Install Rust non-interactively if not already installed
|
||||
if: ${{ matrix.container }}
|
||||
run: |
|
||||
if ! command -v cargo > /dev/null 2>&1; then
|
||||
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y
|
||||
echo "$HOME/.cargo/bin" >> $GITHUB_PATH
|
||||
fi
|
||||
- name: Install dist
|
||||
run: ${{ matrix.install_dist.run }}
|
||||
# Get the dist-manifest
|
||||
- name: Fetch local artifacts
|
||||
uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333
|
||||
with:
|
||||
pattern: artifacts-*
|
||||
path: target/distrib/
|
||||
merge-multiple: true
|
||||
- name: Install dependencies
|
||||
run: |
|
||||
${{ matrix.packages_install }}
|
||||
- name: Build artifacts
|
||||
run: |
|
||||
# Actually do builds and make zips and whatnot
|
||||
dist build ${{ needs.plan.outputs.tag-flag }} --print=linkage --output-format=json ${{ matrix.dist_args }} > dist-manifest.json
|
||||
echo "dist ran successfully"
|
||||
- name: Attest
|
||||
uses: actions/attest@1e69f48acb82d1966a394da916b4c1698aa569d6
|
||||
with:
|
||||
subject-path: "target/distrib/*${{ join(matrix.targets, ', ') }}*"
|
||||
- id: cargo-dist
|
||||
name: Post-build
|
||||
# We force bash here just because github makes it really hard to get values up
|
||||
# to "real" actions without writing to env-vars, and writing to env-vars has
|
||||
# inconsistent syntax between shell and powershell.
|
||||
shell: bash
|
||||
run: |
|
||||
# Parse out what we just built and upload it to scratch storage
|
||||
echo "paths<<EOF" >> "$GITHUB_OUTPUT"
|
||||
dist print-upload-files-from-manifest --manifest dist-manifest.json >> "$GITHUB_OUTPUT"
|
||||
echo "EOF" >> "$GITHUB_OUTPUT"
|
||||
|
||||
cp dist-manifest.json "$BUILD_MANIFEST_NAME"
|
||||
- name: "Upload artifacts"
|
||||
uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9
|
||||
with:
|
||||
name: artifacts-build-local-${{ join(matrix.targets, '_') }}
|
||||
path: |
|
||||
${{ steps.cargo-dist.outputs.paths }}
|
||||
${{ env.BUILD_MANIFEST_NAME }}
|
||||
|
||||
# Build and package all the platform-agnostic(ish) things
|
||||
build-global-artifacts:
|
||||
needs:
|
||||
- plan
|
||||
- build-local-artifacts
|
||||
runs-on: "ubuntu-22.04"
|
||||
env:
|
||||
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
BUILD_MANIFEST_NAME: target/distrib/global-dist-manifest.json
|
||||
steps:
|
||||
- uses: actions/checkout@d23441a48e516b6c34aea4fa41551a30e30af803
|
||||
with:
|
||||
persist-credentials: false
|
||||
submodules: recursive
|
||||
- name: Install cached dist
|
||||
uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333
|
||||
with:
|
||||
name: cargo-dist-cache
|
||||
path: ~/.cargo/bin/
|
||||
- run: chmod +x ~/.cargo/bin/dist
|
||||
# Get all the local artifacts for the global tasks to use (for e.g. checksums)
|
||||
- name: Fetch local artifacts
|
||||
uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333
|
||||
with:
|
||||
pattern: artifacts-*
|
||||
path: target/distrib/
|
||||
merge-multiple: true
|
||||
- id: cargo-dist
|
||||
shell: bash
|
||||
run: |
|
||||
dist build ${{ needs.plan.outputs.tag-flag }} --output-format=json "--artifacts=global" > dist-manifest.json
|
||||
echo "dist ran successfully"
|
||||
|
||||
# Parse out what we just built and upload it to scratch storage
|
||||
echo "paths<<EOF" >> "$GITHUB_OUTPUT"
|
||||
jq --raw-output ".upload_files[]" dist-manifest.json >> "$GITHUB_OUTPUT"
|
||||
echo "EOF" >> "$GITHUB_OUTPUT"
|
||||
|
||||
cp dist-manifest.json "$BUILD_MANIFEST_NAME"
|
||||
- name: "Upload artifacts"
|
||||
uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9
|
||||
with:
|
||||
name: artifacts-build-global
|
||||
path: |
|
||||
${{ steps.cargo-dist.outputs.paths }}
|
||||
${{ env.BUILD_MANIFEST_NAME }}
|
||||
# Determines if we should publish/announce
|
||||
host:
|
||||
needs:
|
||||
- plan
|
||||
- build-local-artifacts
|
||||
- build-global-artifacts
|
||||
# Only run if we're "publishing", and only if plan, local and global didn't fail (skipped is fine)
|
||||
if: ${{ always() && needs.plan.result == 'success' && needs.plan.outputs.publishing == 'true' && (needs.build-global-artifacts.result == 'skipped' || needs.build-global-artifacts.result == 'success') && (needs.build-local-artifacts.result == 'skipped' || needs.build-local-artifacts.result == 'success') }}
|
||||
env:
|
||||
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
runs-on: "ubuntu-22.04"
|
||||
outputs:
|
||||
val: ${{ steps.host.outputs.manifest }}
|
||||
steps:
|
||||
- uses: actions/checkout@d23441a48e516b6c34aea4fa41551a30e30af803
|
||||
with:
|
||||
persist-credentials: false
|
||||
submodules: recursive
|
||||
- name: Install cached dist
|
||||
uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333
|
||||
with:
|
||||
name: cargo-dist-cache
|
||||
path: ~/.cargo/bin/
|
||||
- run: chmod +x ~/.cargo/bin/dist
|
||||
# Fetch artifacts from scratch-storage
|
||||
- name: Fetch artifacts
|
||||
uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333
|
||||
with:
|
||||
pattern: artifacts-*
|
||||
path: target/distrib/
|
||||
merge-multiple: true
|
||||
- id: host
|
||||
shell: bash
|
||||
run: |
|
||||
dist host ${{ needs.plan.outputs.tag-flag }} --steps=upload --steps=release --output-format=json > dist-manifest.json
|
||||
echo "artifacts uploaded and released successfully"
|
||||
cat dist-manifest.json
|
||||
echo "manifest=$(jq -c "." dist-manifest.json)" >> "$GITHUB_OUTPUT"
|
||||
- name: "Upload dist-manifest.json"
|
||||
uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9
|
||||
with:
|
||||
# Overwrite the previous copy
|
||||
name: artifacts-dist-manifest
|
||||
path: dist-manifest.json
|
||||
# Create a GitHub Release while uploading all files to it
|
||||
- name: "Download GitHub Artifacts"
|
||||
uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333
|
||||
with:
|
||||
pattern: artifacts-*
|
||||
path: artifacts
|
||||
merge-multiple: true
|
||||
- name: Cleanup
|
||||
run: |
|
||||
# Remove the granular manifests
|
||||
rm -f artifacts/*-dist-manifest.json
|
||||
- name: Create GitHub Release
|
||||
env:
|
||||
PRERELEASE_FLAG: "${{ fromJson(steps.host.outputs.manifest).announcement_is_prerelease && '--prerelease' || '' }}"
|
||||
ANNOUNCEMENT_TITLE: "${{ fromJson(steps.host.outputs.manifest).announcement_title }}"
|
||||
ANNOUNCEMENT_BODY: "${{ fromJson(steps.host.outputs.manifest).announcement_github_body }}"
|
||||
RELEASE_COMMIT: "${{ github.sha }}"
|
||||
run: |
|
||||
# Write and read notes from a file to avoid quoting breaking things
|
||||
echo "$ANNOUNCEMENT_BODY" > $RUNNER_TEMP/notes.txt
|
||||
|
||||
gh release create "${{ needs.plan.outputs.tag }}" --target "$RELEASE_COMMIT" $PRERELEASE_FLAG --title "$ANNOUNCEMENT_TITLE" --notes-file "$RUNNER_TEMP/notes.txt" artifacts/*
|
||||
|
||||
publish-homebrew-formula:
|
||||
needs:
|
||||
- plan
|
||||
- host
|
||||
runs-on: "ubuntu-22.04"
|
||||
env:
|
||||
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
PLAN: ${{ needs.plan.outputs.val }}
|
||||
GITHUB_USER: "axo bot"
|
||||
GITHUB_EMAIL: "admin+bot@axo.dev"
|
||||
if: ${{ !fromJson(needs.plan.outputs.val).announcement_is_prerelease || fromJson(needs.plan.outputs.val).publish_prereleases }}
|
||||
steps:
|
||||
- uses: actions/checkout@d23441a48e516b6c34aea4fa41551a30e30af803
|
||||
with:
|
||||
persist-credentials: true
|
||||
repository: "evanwhittaker/homebrew-tap"
|
||||
token: ${{ secrets.HOMEBREW_TAP_TOKEN }}
|
||||
# So we have access to the formula
|
||||
- name: Fetch homebrew formulae
|
||||
uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333
|
||||
with:
|
||||
pattern: artifacts-*
|
||||
path: Formula/
|
||||
merge-multiple: true
|
||||
# This is extra complex because you can make your Formula name not match your app name
|
||||
# so we need to find releases with a *.rb file, and publish with that filename.
|
||||
- name: Commit formula files
|
||||
run: |
|
||||
git config --global user.name "${GITHUB_USER}"
|
||||
git config --global user.email "${GITHUB_EMAIL}"
|
||||
|
||||
for release in $(echo "$PLAN" | jq --compact-output '.releases[] | select([.artifacts[] | endswith(".rb")] | any)'); do
|
||||
filename=$(echo "$release" | jq '.artifacts[] | select(endswith(".rb"))' --raw-output)
|
||||
name=$(echo "$filename" | sed "s/\.rb$//")
|
||||
version=$(echo "$release" | jq .app_version --raw-output)
|
||||
|
||||
export PATH="/home/linuxbrew/.linuxbrew/bin:$PATH"
|
||||
brew update
|
||||
# We avoid reformatting user-provided data such as the app description and homepage.
|
||||
brew style --except-cops FormulaAudit/Homepage,FormulaAudit/Desc,FormulaAuditStrict --fix "Formula/${filename}" || true
|
||||
|
||||
git add "Formula/${filename}"
|
||||
git commit -m "${name} ${version}"
|
||||
done
|
||||
git push
|
||||
|
||||
custom-publish-crates:
|
||||
needs:
|
||||
- plan
|
||||
- host
|
||||
if: ${{ !fromJson(needs.plan.outputs.val).announcement_is_prerelease || fromJson(needs.plan.outputs.val).publish_prereleases }}
|
||||
uses: ./.github/workflows/publish-crates.yml
|
||||
with:
|
||||
plan: ${{ needs.plan.outputs.val }}
|
||||
secrets: inherit
|
||||
# publish jobs get escalated permissions
|
||||
permissions:
|
||||
"contents": "read"
|
||||
"id-token": "write"
|
||||
|
||||
announce:
|
||||
needs:
|
||||
- plan
|
||||
- host
|
||||
- publish-homebrew-formula
|
||||
- custom-publish-crates
|
||||
# use "always() && ..." to allow us to wait for all publish jobs while
|
||||
# still allowing individual publish jobs to skip themselves (for prereleases).
|
||||
# "host" however must run to completion, no skipping allowed!
|
||||
if: ${{ always() && needs.host.result == 'success' && (needs.publish-homebrew-formula.result == 'skipped' || needs.publish-homebrew-formula.result == 'success') && (needs.custom-publish-crates.result == 'skipped' || needs.custom-publish-crates.result == 'success') }}
|
||||
runs-on: "ubuntu-22.04"
|
||||
env:
|
||||
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
steps:
|
||||
- uses: actions/checkout@d23441a48e516b6c34aea4fa41551a30e30af803
|
||||
with:
|
||||
persist-credentials: false
|
||||
submodules: recursive
|
||||
@@ -300,28 +300,25 @@ python3 scripts/version_check_test.py # the check's own tests
|
||||
|
||||
Below 1.0, a minor bump may break config, flags or the `--rpc` protocol; a patch never does.
|
||||
|
||||
## Publishing to crates.io
|
||||
## Releasing
|
||||
|
||||
**In this order.** A crate cannot be published before the crates it depends on exist in the
|
||||
registry, and a published version is immutable, so a wrong order burns a version number rather than
|
||||
retrying.
|
||||
A release is a tag. When `main` holds the version to release, with its `CHANGELOG.md` section
|
||||
written:
|
||||
|
||||
```bash
|
||||
cargo publish -p luxe-core
|
||||
cargo publish -p luxe-providers -p luxe-tools -p luxe-lsp -p luxe-dap -p luxe-mcp -p luxe-tui
|
||||
cargo publish -p luxe-cli # the binary; `cargo install luxe-cli` installs `luxe`
|
||||
git tag v0.2.0 && git push origin v0.2.0
|
||||
```
|
||||
|
||||
Before the first publish, `cargo package -p luxe-tui` (or any crate with an internal dependency)
|
||||
fails with "no matching package named `luxe-core`" — it resolves the `version` on the path dep
|
||||
against a registry that has not seen it yet. That is expected rather than a broken manifest. To
|
||||
check every manifest at once, package the whole workspace, which resolves the internal graph
|
||||
itself:
|
||||
`.github/workflows/release.yml`, which `dist` generates from `dist-workspace.toml`, then builds
|
||||
every target, puts the archives, the install scripts and their updater on the GitHub release with
|
||||
an attestation for each file, publishes the Homebrew formula to `evanwhittaker/homebrew-tap`, and
|
||||
publishes the crates to crates.io (`publish-crates.yml`) before announcing. Never edit
|
||||
`release.yml`; change `dist-workspace.toml` and run `dist generate`.
|
||||
|
||||
```bash
|
||||
cargo package --workspace --no-verify
|
||||
cargo publish --dry-run -p luxe-core # the one crate that can also verify pre-publish
|
||||
```
|
||||
The crates go up by crates.io Trusted Publishing, so no token is stored: each crate's trusted
|
||||
publisher is this repository's `release.yml`. A crate whose version crates.io already has is
|
||||
skipped, so a re-run after a partial publish carries on. `cargo publish --workspace --dry-run`
|
||||
packages and builds every crate the way the registry will, dependencies first.
|
||||
|
||||
## Development-only files
|
||||
|
||||
|
||||
@@ -121,3 +121,8 @@ field_reassign_with_default = "allow"
|
||||
nonminimal_bool = "allow"
|
||||
match_same_arms = "allow"
|
||||
unnecessary_filter_map = "allow"
|
||||
|
||||
# The profile that 'dist' will build with
|
||||
[profile.dist]
|
||||
inherits = "release"
|
||||
lto = "thin"
|
||||
|
||||
16
README.md
16
README.md
@@ -49,12 +49,20 @@ and [the guide lists them](https://luxe.dev/docs/security/#what-luxe-sends-over-
|
||||
## Install
|
||||
|
||||
```bash
|
||||
cargo install luxe-cli
|
||||
luxe --version
|
||||
# macOS and Linux
|
||||
curl --proto '=https' --tlsv1.2 -LsSf https://github.com/evanwhittaker/luxe/releases/latest/download/luxe-cli-installer.sh | sh
|
||||
|
||||
# Homebrew
|
||||
brew install evanwhittaker/tap/luxe
|
||||
|
||||
# Windows (PowerShell)
|
||||
powershell -ExecutionPolicy Bypass -c "irm https://github.com/evanwhittaker/luxe/releases/latest/download/luxe-cli-installer.ps1 | iex"
|
||||
|
||||
# Cargo (Rust 1.89 or newer)
|
||||
cargo install --locked luxe-cli
|
||||
```
|
||||
|
||||
You need Rust 1.89 or newer; [rustup](https://rustup.rs) installs it. To update, run the same
|
||||
command with `--force`. To build from source:
|
||||
To update, run `luxe update`. To build from source:
|
||||
|
||||
```bash
|
||||
git clone https://github.com/evanwhittaker/luxe.git
|
||||
|
||||
32
SECURITY.md
Normal file
32
SECURITY.md
Normal file
@@ -0,0 +1,32 @@
|
||||
# Security
|
||||
|
||||
Luxe runs a model's commands on your machine, so a hole in it matters. If you find one, please tell
|
||||
me privately before anyone else.
|
||||
|
||||
## Reporting
|
||||
|
||||
[Open a private advisory](https://github.com/evanwhittaker/luxe/security/advisories/new) on GitHub,
|
||||
or email [contact@luxe.dev](mailto:contact@luxe.dev). Say what you did, what happened, and the
|
||||
Luxe version (`luxe --version`). A transcript or a minimal repository that shows it helps most.
|
||||
|
||||
I'll answer within a few days, keep you posted while it's fixed, and credit you in the advisory and
|
||||
the release notes unless you'd rather not be named. Please give the fix time to ship before you
|
||||
publish.
|
||||
|
||||
## What counts
|
||||
|
||||
Anything that gets past what [Security and permissions](https://luxe.dev/docs/security/) promises:
|
||||
|
||||
- a tool call that runs, reads or writes without the prompt or the rule that should have stopped it
|
||||
- a way for a project, an instruction file or an MCP server to grant itself trust you didn't give
|
||||
- a secret reaching a tool result, a log, the wire capture or the model when it should be scrubbed
|
||||
- a network request [the guide doesn't list](https://luxe.dev/docs/security/#what-luxe-sends-over-the-network)
|
||||
- a release artifact that isn't what this repository built
|
||||
|
||||
What the model does with permission you gave it, including anything under `--yolo`, is working as
|
||||
designed. So is a prompt injection that only gets the agent to ask you for something you then
|
||||
approve; one that gets around the asking is a real bug.
|
||||
|
||||
## Supported versions
|
||||
|
||||
Fixes go into the newest release. `luxe update` gets you there.
|
||||
@@ -52,7 +52,9 @@ async fn run_steps(steps: &[&[&str]]) -> anyhow::Result<()> {
|
||||
let Some((program, args)) = step.split_first() else { continue };
|
||||
let line = step.join(" ");
|
||||
println!("Running: {line}");
|
||||
let status = tokio::process::Command::new(program)
|
||||
let beside =
|
||||
std::env::current_exe().ok().and_then(|exe| exe.parent().map(Path::to_path_buf));
|
||||
let status = tokio::process::Command::new(program_path(program, beside.as_deref()))
|
||||
.args(args)
|
||||
.status()
|
||||
.await
|
||||
@@ -64,6 +66,16 @@ async fn run_steps(steps: &[&[&str]]) -> anyhow::Result<()> {
|
||||
Ok(())
|
||||
}
|
||||
|
||||
/// Where to run `program` from: `beside` this binary when it is there, which is where the
|
||||
/// installer put its updater, whether or not that directory is on `PATH`; by name otherwise.
|
||||
fn program_path(program: &str, beside: Option<&Path>) -> PathBuf {
|
||||
let name = format!("{program}{}", std::env::consts::EXE_SUFFIX);
|
||||
beside
|
||||
.map(|dir| dir.join(name))
|
||||
.filter(|path| path.is_file())
|
||||
.unwrap_or_else(|| PathBuf::from(program))
|
||||
}
|
||||
|
||||
/// How the update landed, read from the `luxe` a shell would run now.
|
||||
#[derive(Debug, PartialEq, Eq)]
|
||||
enum Outcome {
|
||||
|
||||
@@ -11,6 +11,18 @@ fn copies() -> (tempfile::TempDir, PathBuf, PathBuf) {
|
||||
(dir, updated, other)
|
||||
}
|
||||
|
||||
/// The installer's updater runs from beside the binary even off `PATH`; anything not there, cargo
|
||||
/// or brew, is found by name.
|
||||
#[test]
|
||||
fn a_program_beside_the_binary_runs_from_there() {
|
||||
let dir = tempfile::tempdir().expect("tempdir");
|
||||
let updater = dir.path().join(format!("luxe-cli-update{}", std::env::consts::EXE_SUFFIX));
|
||||
std::fs::write(&updater, b"").expect("a stand-in updater");
|
||||
assert_eq!(program_path("luxe-cli-update", Some(dir.path())), updater);
|
||||
assert_eq!(program_path("brew", Some(dir.path())), PathBuf::from("brew"));
|
||||
assert_eq!(program_path("luxe-cli-update", None), PathBuf::from("luxe-cli-update"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn the_version_is_the_last_word_when_it_is_semver() {
|
||||
assert_eq!(parse_version("luxe 0.2.0\n").as_deref(), Some("0.2.0"));
|
||||
|
||||
@@ -857,14 +857,15 @@ it, showing each one before it runs:
|
||||
|
||||
| Installed with | `luxe update` runs |
|
||||
| --- | --- |
|
||||
| Cargo | `cargo install --locked --force luxe-cli` |
|
||||
| The install script | `luxe-cli-update`, the updater it put beside `luxe` |
|
||||
| Homebrew | `brew update`, then `brew upgrade luxe` |
|
||||
| Cargo | `cargo install --locked --force luxe-cli` |
|
||||
|
||||
Luxe never downloads or replaces its own program; the package manager that installed it does. A
|
||||
copy your system's package manager owns is left to it, and a downloaded one points you at the
|
||||
releases page. On Windows, Luxe can't be replaced while it runs, so it prints the command to run
|
||||
once it has exited. Afterwards it checks that the `luxe` your shell finds is the new version, and
|
||||
says so if another copy earlier on your `PATH` is in the way. `luxe update --check` only reports.
|
||||
Luxe never downloads or replaces its own program; whatever installed it does. A copy your system's
|
||||
package manager owns is left to it, and a downloaded archive points you at the releases page. On
|
||||
Windows, Luxe can't be replaced while it runs, so it prints the command to run once it has exited.
|
||||
Afterwards it checks that the `luxe` your shell finds is the new version, and says so if another
|
||||
copy earlier on your `PATH` is in the way. `luxe update --check` only reports.
|
||||
|
||||
To stop the daily check:
|
||||
|
||||
@@ -2129,20 +2130,49 @@ order: 1
|
||||
group: "Get started"
|
||||
---
|
||||
|
||||
## Install with Cargo
|
||||
## Install
|
||||
|
||||
On macOS and Linux, the install script puts `luxe` in `~/.local/bin`, or in `$LUXE_INSTALL_DIR`
|
||||
when it is set, and adds that to your `PATH`:
|
||||
|
||||
```bash
|
||||
cargo install luxe-cli
|
||||
luxe --version
|
||||
curl --proto '=https' --tlsv1.2 -LsSf https://github.com/evanwhittaker/luxe/releases/latest/download/luxe-cli-installer.sh | sh
|
||||
```
|
||||
|
||||
This installs the `luxe` command. You need a recent stable Rust; [rustup](https://rustup.rs)
|
||||
installs one.
|
||||
On Windows, in PowerShell:
|
||||
|
||||
```powershell
|
||||
powershell -ExecutionPolicy Bypass -c "irm https://github.com/evanwhittaker/luxe/releases/latest/download/luxe-cli-installer.ps1 | iex"
|
||||
```
|
||||
|
||||
With Homebrew, on macOS or Linux:
|
||||
|
||||
```bash
|
||||
brew install evanwhittaker/tap/luxe
|
||||
```
|
||||
|
||||
With Cargo, which builds it, so you need Rust 1.89 or newer ([rustup](https://rustup.rs) installs
|
||||
one):
|
||||
|
||||
```bash
|
||||
cargo install --locked luxe-cli
|
||||
```
|
||||
|
||||
Any of them installs the `luxe` command; `luxe --version` checks it worked.
|
||||
|
||||
To update, run `luxe update`, or `/update` inside Luxe. Luxe checks once a day for a newer release
|
||||
and says so on the start screen; see [Updates](configuration.md#updates) for how it updates and how
|
||||
to turn the check off.
|
||||
|
||||
### Check a download
|
||||
|
||||
Every file on a release carries a build attestation, so you can confirm it came from this
|
||||
repository's release workflow and nowhere else:
|
||||
|
||||
```bash
|
||||
gh attestation verify luxe-cli-x86_64-unknown-linux-gnu.tar.xz --repo evanwhittaker/luxe
|
||||
```
|
||||
|
||||
## Build from source
|
||||
|
||||
```bash
|
||||
|
||||
@@ -51,7 +51,7 @@ fn a_search_lists_pull_requests_and_issues_with_where_they_are() {
|
||||
|
||||
pub(super) const MERGED_NONE: &str = include_str!("../../fixtures/merged_below_none.json");
|
||||
|
||||
/// Real answers from restacking a scratch stack on luxe-dev: the bottom squash-merged with its
|
||||
/// Real answers from restacking a scratch stack: the bottom squash-merged with its
|
||||
/// branch kept, and a layer with nothing merged below it. A retargeted one names the base it
|
||||
/// was moved from.
|
||||
#[test]
|
||||
@@ -72,7 +72,7 @@ fn what_merged_below_a_stack_is_read_with_where_it_went() {
|
||||
|
||||
pub(super) const STATUS_UNSTACKED: &str =
|
||||
include_str!("../../fixtures/branch_status_unstacked.json");
|
||||
/// Luxe's own chain on luxe-dev, read from the middle: seven below down to `master`, two above,
|
||||
/// A real chain of Luxe's own, read from the middle: seven below down to `master`, two above,
|
||||
/// and the evidence that checks wait for trunk — the bottom one has them, this one none.
|
||||
#[test]
|
||||
fn a_pull_request_in_the_middle_of_a_stack_knows_where_it_sits() {
|
||||
|
||||
@@ -28,7 +28,7 @@ fn gh_names_a_repository_off_github_com_by_host() {
|
||||
assert!(!repository.is("nora-quinn/luxe"));
|
||||
}
|
||||
|
||||
// From the scratch pull request nora-quinn/luxe-dev#141, posted to and closed for this.
|
||||
// From a scratch pull request, posted to and closed for this.
|
||||
pub(super) const PR_FILES: &str = include_str!("../../fixtures/pr_files.jsonl");
|
||||
pub(super) const THREADS_OWN: &str = include_str!("../../fixtures/review_threads_own.json");
|
||||
pub(super) const THREAD_REPLY: &str = include_str!("../../fixtures/thread_reply.json");
|
||||
@@ -135,8 +135,8 @@ fn the_conversation_comes_with_the_threads() {
|
||||
assert!(before.conversation.is_empty() && !before.threads.is_empty());
|
||||
}
|
||||
|
||||
/// On luxe-dev#169 the reader answered the first comment from Luxe, so it and the answer stay
|
||||
/// quiet, and the review's summary is what is still asked.
|
||||
/// On a real pull request the reader answered the first comment from Luxe, so it and the answer
|
||||
/// stay quiet, and the review's summary is what is still asked.
|
||||
#[test]
|
||||
fn an_answered_comment_on_a_real_pull_request_asks_nothing() {
|
||||
let read = parse_review_threads(THREADS_CONVERSATION).unwrap();
|
||||
|
||||
@@ -272,8 +272,8 @@ fn the_on_disk_entry_shape_is_frozen() {
|
||||
r#"{"id":"e3","parent_id":"e2","ts":7,"kind":{"kind":"header","data":{"cwd":"/w","created":7}}}"#
|
||||
);
|
||||
|
||||
// A link to the pull request a session worked on, copied from the round trip that closed
|
||||
// #146 on luxe-dev: `luxe --from-pr` reads exactly this
|
||||
// A link to the pull request a session worked on, copied from a real round trip that closed
|
||||
// one: `luxe --from-pr` reads exactly this
|
||||
let stored = r#"{"id":"f25fd65c-ee99-4db8-9ed9-76aa08ed7fd9","parent_id":"035e7a31-2d6b-410a-b1d1-361920bf0615","ts":1790289080,"kind":{"kind":"pull_request_link","data":{"number":146,"url":"https://github.com/nora-quinn/luxe-dev/pull/146"}}}"#;
|
||||
let entry: Entry = serde_json::from_str(stored).unwrap();
|
||||
assert_eq!(
|
||||
|
||||
@@ -47,16 +47,32 @@ pub enum InstallSource {
|
||||
Homebrew,
|
||||
/// A path a distribution's package manager owns (`/usr/bin`, `/bin`).
|
||||
SystemPackage,
|
||||
/// A release archive, an installer script, `/usr/local/bin`, or a local build.
|
||||
/// Luxe's own installer script, known by the updater it puts beside the binary.
|
||||
Installer,
|
||||
/// A release archive, `/usr/local/bin`, or a local build.
|
||||
Archive,
|
||||
}
|
||||
|
||||
/// The updater Luxe's installer script puts beside the binary, named `<package>-update` by dist.
|
||||
pub const INSTALLER_UPDATER: &str = "luxe-cli-update";
|
||||
|
||||
impl InstallSource {
|
||||
/// Classify the running binary. Falls back to [`InstallSource::Archive`], which is the state
|
||||
/// that gives the most cautious advice ("download the new release") rather than the most
|
||||
/// confident.
|
||||
pub fn detect() -> Self {
|
||||
std::env::current_exe().map(|path| Self::from_path(&path)).unwrap_or(Self::Archive)
|
||||
std::env::current_exe().map(|path| Self::from_install(&path)).unwrap_or(Self::Archive)
|
||||
}
|
||||
|
||||
/// Classify a binary by what sits beside it, then by its path. The installer's updater beside
|
||||
/// it decides first: the installer puts it wherever it installs, `~/.cargo/bin` included when
|
||||
/// told to, and no path says "installer" on its own.
|
||||
pub fn from_install(binary: &Path) -> Self {
|
||||
let updater = format!("{INSTALLER_UPDATER}{}", std::env::consts::EXE_SUFFIX);
|
||||
match binary.parent().map(|dir| dir.join(updater)) {
|
||||
Some(path) if path.is_file() => Self::Installer,
|
||||
_ => Self::from_path(binary),
|
||||
}
|
||||
}
|
||||
|
||||
/// Classify a path. Split out from [`Self::detect`] because a function that can only be
|
||||
@@ -94,6 +110,7 @@ impl InstallSource {
|
||||
match self {
|
||||
Self::Cargo => Some(&[&["cargo", "install", "--locked", "--force", "luxe-cli"]]),
|
||||
Self::Homebrew => Some(&[&["brew", "update"], &["brew", "upgrade", "luxe"]]),
|
||||
Self::Installer => Some(&[&[INSTALLER_UPDATER]]),
|
||||
// Which package manager owns it is not knowable without querying one, and guessing
|
||||
// `apt` on an Arch machine is the failure this whole function exists to avoid.
|
||||
Self::SystemPackage => None,
|
||||
|
||||
@@ -31,6 +31,36 @@ fn the_update_steps_are_the_owners_own_commands() {
|
||||
assert_eq!(InstallSource::Archive.update_steps(), None, "a download has no owner to ask");
|
||||
}
|
||||
|
||||
/// The installer's updater beside the binary marks an installer copy wherever it lives, a
|
||||
/// `~/.cargo/bin` it was told to use included, and that updater is its update. Without it the
|
||||
/// path decides, as before.
|
||||
#[test]
|
||||
fn the_installers_updater_beside_the_binary_marks_an_installer_copy() {
|
||||
let dir = tempfile::tempdir().expect("tempdir");
|
||||
let bin = dir.path().join(".cargo/bin");
|
||||
std::fs::create_dir_all(&bin).expect("bin dir");
|
||||
let luxe = bin.join(format!("luxe{}", std::env::consts::EXE_SUFFIX));
|
||||
std::fs::write(&luxe, b"").expect("a stand-in luxe");
|
||||
assert_eq!(InstallSource::from_install(&luxe), InstallSource::Cargo, "no updater: the path");
|
||||
|
||||
let updater = bin.join(format!("{INSTALLER_UPDATER}{}", std::env::consts::EXE_SUFFIX));
|
||||
std::fs::write(&updater, b"").expect("a stand-in updater");
|
||||
assert_eq!(InstallSource::from_install(&luxe), InstallSource::Installer);
|
||||
let steps: &[&[&str]] = &[&["luxe-cli-update"]];
|
||||
assert_eq!(InstallSource::Installer.update_steps(), Some(steps));
|
||||
}
|
||||
|
||||
/// A directory named like the updater is not the updater.
|
||||
#[test]
|
||||
fn a_directory_named_like_the_updater_does_not_count() {
|
||||
let dir = tempfile::tempdir().expect("tempdir");
|
||||
let luxe = dir.path().join("luxe");
|
||||
std::fs::write(&luxe, b"").expect("a stand-in luxe");
|
||||
let name = format!("{INSTALLER_UPDATER}{}", std::env::consts::EXE_SUFFIX);
|
||||
std::fs::create_dir(dir.path().join(name)).expect("a directory");
|
||||
assert_ne!(InstallSource::from_install(&luxe), InstallSource::Installer);
|
||||
}
|
||||
|
||||
/// Homebrew is checked first because its Linux and Intel-macOS prefixes sit *inside* paths the
|
||||
/// other arms would otherwise claim.
|
||||
#[test]
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
//! `git` `checks` — why CI is failing, bounded.
|
||||
//!
|
||||
//! `gh run view --log-failed` prints every line of every failing step: 3,671 lines for one Clippy
|
||||
//! step on luxe-dev, with the error in the last dozen. This reads the same logs through GitHub
|
||||
//! step of Luxe's own, with the error in the last dozen. This reads the same logs through GitHub
|
||||
//! and keeps the tail of each failing step, says how much it left out, and also lists the failing
|
||||
//! checks that are not Actions jobs at all — a commit status from another CI, which that command
|
||||
//! cannot see. Reading only; re-running a job stays behind the permission engine's `ask`.
|
||||
|
||||
@@ -331,14 +331,17 @@ async fn without_a_pull_request_the_checks_on_head_are_read() {
|
||||
);
|
||||
}
|
||||
|
||||
/// Against the real `gh` and luxe-dev's #119, whose getrandom bump failed three jobs: each
|
||||
/// comes back with the compiler's error at the end of its tail. `cargo test -- --ignored`.
|
||||
/// Against the real `gh` and a pull request of this checkout's repository whose CI failed: each
|
||||
/// failing job comes back with the compiler's error at the end of its tail. Run with
|
||||
/// `LUXE_FAILED_PR=<number> cargo test -- --ignored`.
|
||||
#[tokio::test]
|
||||
#[ignore = "needs a signed-in gh and the network"]
|
||||
#[ignore = "needs a signed-in gh, the network, and LUXE_FAILED_PR"]
|
||||
async fn a_real_failed_run_ends_in_its_error() {
|
||||
let number = std::env::var("LUXE_FAILED_PR")
|
||||
.expect("LUXE_FAILED_PR names a pull request in this repository whose checks failed");
|
||||
let root = Path::new(env!("CARGO_MANIFEST_DIR")).join("../..");
|
||||
let github = luxe_core::github::GhCli::new();
|
||||
let text = checks(&github, &root, &["119".into()]).await.unwrap();
|
||||
assert!(text.starts_with("1 check failing on #119"), "{text}");
|
||||
let text = checks(&github, &root, std::slice::from_ref(&number)).await.unwrap();
|
||||
assert!(text.contains(&format!("failing on #{number}")), "{text}");
|
||||
assert!(text.contains("##[error]Process completed with exit code"), "{text}");
|
||||
}
|
||||
|
||||
@@ -177,7 +177,7 @@ fn collapse_blank_runs(text: &str) -> String {
|
||||
mod tests {
|
||||
use super::readable;
|
||||
|
||||
/// Dependabot's commit list, from luxe-dev #197's real body: a summary heading, then a list
|
||||
/// Dependabot's commit list, from a real pull request's body: a summary heading, then a list
|
||||
/// of linked commit ids, with an entity decoded and no tag left.
|
||||
#[test]
|
||||
fn a_dependabot_commit_list_reads_as_a_list() {
|
||||
|
||||
45
dist-workspace.toml
Normal file
45
dist-workspace.toml
Normal file
@@ -0,0 +1,45 @@
|
||||
# How Luxe is released. dist reads this and writes .github/workflows/release.yml from it, so the
|
||||
# workflow is never edited by hand: change this, then run `dist generate`. Run `dist init` only to
|
||||
# move to a new dist version; with `--yes` it answers its own questions and drops settings here.
|
||||
#
|
||||
# A release starts when a `v<version>` tag is pushed for the version on main. dist builds every
|
||||
# target, puts the archives and installers on the GitHub release, then publishes the Homebrew
|
||||
# formula and the crates (.github/workflows/publish-crates.yml), and only then announces.
|
||||
|
||||
[workspace]
|
||||
members = ["cargo:."]
|
||||
|
||||
[dist]
|
||||
cargo-dist-version = "0.33.0"
|
||||
ci = "github"
|
||||
targets = [
|
||||
"aarch64-apple-darwin",
|
||||
"aarch64-unknown-linux-gnu",
|
||||
"x86_64-apple-darwin",
|
||||
"x86_64-unknown-linux-gnu",
|
||||
"x86_64-pc-windows-msvc",
|
||||
]
|
||||
installers = ["shell", "powershell", "homebrew"]
|
||||
# Not `~/.cargo/bin`, dist's default: a copy there reads as a cargo install, and `luxe update`
|
||||
# would rebuild it from source with a toolchain the installer's users may not have
|
||||
install-path = ["$LUXE_INSTALL_DIR/", "~/.local/bin"]
|
||||
# The installer's own updater, beside the binary; `luxe update` runs it for an installer copy
|
||||
install-updater = true
|
||||
tap = "evanwhittaker/homebrew-tap"
|
||||
# `brew install evanwhittaker/tap/luxe`, not `luxe-cli`: the command is `luxe`
|
||||
formula = "luxe"
|
||||
publish-jobs = ["homebrew", "./publish-crates"]
|
||||
# A called workflow gets no more than its caller grants: checking out needs `contents`, and
|
||||
# Trusted Publishing needs `id-token`
|
||||
github-custom-job-permissions = { "publish-crates" = { contents = "read", id-token = "write" } }
|
||||
# Provenance for every artifact, so a download can be checked against this repository's build
|
||||
github-attestations = true
|
||||
pr-run-mode = "plan"
|
||||
|
||||
# Pinned to commits, as every other workflow here is, so a moved tag cannot change what a release
|
||||
# runs. checkout v6.1.0, upload-artifact v7.0.2, download-artifact v8.0.2, attest v4.2.2
|
||||
[dist.github-action-commits]
|
||||
"actions/checkout" = "d23441a48e516b6c34aea4fa41551a30e30af803"
|
||||
"actions/upload-artifact" = "cf430e030ddbb5b0abf93d22962f4752f3646cd9"
|
||||
"actions/download-artifact" = "9000827ccba6bdab643e8b6fd33ac0654aef8333"
|
||||
"actions/attest" = "1e69f48acb82d1966a394da916b4c1698aa569d6"
|
||||
@@ -150,14 +150,15 @@ it, showing each one before it runs:
|
||||
|
||||
| Installed with | `luxe update` runs |
|
||||
| --- | --- |
|
||||
| Cargo | `cargo install --locked --force luxe-cli` |
|
||||
| The install script | `luxe-cli-update`, the updater it put beside `luxe` |
|
||||
| Homebrew | `brew update`, then `brew upgrade luxe` |
|
||||
| Cargo | `cargo install --locked --force luxe-cli` |
|
||||
|
||||
Luxe never downloads or replaces its own program; the package manager that installed it does. A
|
||||
copy your system's package manager owns is left to it, and a downloaded one points you at the
|
||||
releases page. On Windows, Luxe can't be replaced while it runs, so it prints the command to run
|
||||
once it has exited. Afterwards it checks that the `luxe` your shell finds is the new version, and
|
||||
says so if another copy earlier on your `PATH` is in the way. `luxe update --check` only reports.
|
||||
Luxe never downloads or replaces its own program; whatever installed it does. A copy your system's
|
||||
package manager owns is left to it, and a downloaded archive points you at the releases page. On
|
||||
Windows, Luxe can't be replaced while it runs, so it prints the command to run once it has exited.
|
||||
Afterwards it checks that the `luxe` your shell finds is the new version, and says so if another
|
||||
copy earlier on your `PATH` is in the way. `luxe update --check` only reports.
|
||||
|
||||
To stop the daily check:
|
||||
|
||||
|
||||
@@ -5,20 +5,49 @@ order: 1
|
||||
group: "Get started"
|
||||
---
|
||||
|
||||
## Install with Cargo
|
||||
## Install
|
||||
|
||||
On macOS and Linux, the install script puts `luxe` in `~/.local/bin`, or in `$LUXE_INSTALL_DIR`
|
||||
when it is set, and adds that to your `PATH`:
|
||||
|
||||
```bash
|
||||
cargo install luxe-cli
|
||||
luxe --version
|
||||
curl --proto '=https' --tlsv1.2 -LsSf https://github.com/evanwhittaker/luxe/releases/latest/download/luxe-cli-installer.sh | sh
|
||||
```
|
||||
|
||||
This installs the `luxe` command. You need a recent stable Rust; [rustup](https://rustup.rs)
|
||||
installs one.
|
||||
On Windows, in PowerShell:
|
||||
|
||||
```powershell
|
||||
powershell -ExecutionPolicy Bypass -c "irm https://github.com/evanwhittaker/luxe/releases/latest/download/luxe-cli-installer.ps1 | iex"
|
||||
```
|
||||
|
||||
With Homebrew, on macOS or Linux:
|
||||
|
||||
```bash
|
||||
brew install evanwhittaker/tap/luxe
|
||||
```
|
||||
|
||||
With Cargo, which builds it, so you need Rust 1.89 or newer ([rustup](https://rustup.rs) installs
|
||||
one):
|
||||
|
||||
```bash
|
||||
cargo install --locked luxe-cli
|
||||
```
|
||||
|
||||
Any of them installs the `luxe` command; `luxe --version` checks it worked.
|
||||
|
||||
To update, run `luxe update`, or `/update` inside Luxe. Luxe checks once a day for a newer release
|
||||
and says so on the start screen; see [Updates](configuration.md#updates) for how it updates and how
|
||||
to turn the check off.
|
||||
|
||||
### Check a download
|
||||
|
||||
Every file on a release carries a build attestation, so you can confirm it came from this
|
||||
repository's release workflow and nowhere else:
|
||||
|
||||
```bash
|
||||
gh attestation verify luxe-cli-x86_64-unknown-linux-gnu.tar.xz --repo evanwhittaker/luxe
|
||||
```
|
||||
|
||||
## Build from source
|
||||
|
||||
```bash
|
||||
|
||||
@@ -3,13 +3,20 @@
|
||||
|
||||
type Channel = { id: string; label: string; command: string; note?: string };
|
||||
|
||||
const releases = "https://github.com/evanwhittaker/luxe/releases/latest/download";
|
||||
const channels: Channel[] = [
|
||||
{ id: "cargo", label: "cargo", command: "cargo install luxe-cli" },
|
||||
{
|
||||
id: "source",
|
||||
label: "source",
|
||||
command: "git clone https://github.com/evanwhittaker/luxe && cd luxe && cargo build --release",
|
||||
id: "shell",
|
||||
label: "shell",
|
||||
command: `curl --proto '=https' --tlsv1.2 -LsSf ${releases}/luxe-cli-installer.sh | sh`,
|
||||
},
|
||||
{ id: "brew", label: "brew", command: "brew install evanwhittaker/tap/luxe" },
|
||||
{
|
||||
id: "windows",
|
||||
label: "windows",
|
||||
command: `powershell -ExecutionPolicy Bypass -c "irm ${releases}/luxe-cli-installer.ps1 | iex"`,
|
||||
},
|
||||
{ id: "cargo", label: "cargo", command: "cargo install --locked luxe-cli" },
|
||||
];
|
||||
|
||||
let active = $state(channels[0]);
|
||||
|
||||
@@ -72,7 +72,7 @@ const NARROW = { mobileCols: 72, mobileRows: 24 };
|
||||
</div>
|
||||
|
||||
<p class="hero__note muted">
|
||||
Works on Linux, macOS, and Windows. <a href="/docs/install/#what-it-needs">Learn more</a>.
|
||||
Works on Linux, macOS, and Windows. <a href="/docs/install/#requirements">Learn more</a>.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
@@ -611,8 +611,8 @@ const NARROW = { mobileCols: 72, mobileRows: 24 };
|
||||
container-type: inline-size;
|
||||
grid-area: 1 / 1;
|
||||
display: grid;
|
||||
/* An auto track grows to its widest unbreakable line, and the source install command is one:
|
||||
it pushed the column, and everything centered in it, under the demo */
|
||||
/* An auto track grows to its widest unbreakable line, and an install command is one: it pushed
|
||||
the column, and everything centered in it, under the demo */
|
||||
grid-template-columns: minmax(0, 1fr);
|
||||
justify-items: center;
|
||||
text-align: center;
|
||||
@@ -956,7 +956,7 @@ const NARROW = { mobileCols: 72, mobileRows: 24 };
|
||||
}
|
||||
|
||||
/* Centered as a block, but its contents are a terminal: tab labels and a shell command read from
|
||||
the left, and the inherited centering put `cargo install luxe-cli` in the middle of its own box. */
|
||||
the left, and the inherited centering put the install command in the middle of its own box. */
|
||||
.hero__install {
|
||||
width: min(100%, 44rem);
|
||||
margin-bottom: var(--space-3);
|
||||
|
||||
Reference in New Issue
Block a user