mirror of
https://github.com/eza-community/eza.git
synced 2025-07-07 19:35:33 +00:00
a481225a6e
This adds `libgit` enabled arm builds, meaning we'll ship both with and without libgit for arm releases. The ever growing justfile is reminding me of the horrors often seen in Makefiles... but fixing that is left as an exercise to the reader (likely me when I find the spoons). This will probably be adjusted slightly on release day, experience shows that the gh-release recipe resists improvements, but I'll deal with that on <commit date> + ~thursday. Closes: #1138 #1060 Signed-off-by: Christina Sørensen <ces@fem.gg>
350 lines
11 KiB
Makefile
350 lines
11 KiB
Makefile
# SPDX-FileCopyrightText: 2024 Christina Sørensen
|
|
# SPDX-License-Identifier: EUPL-1.2
|
|
_default:
|
|
@just -l
|
|
|
|
all: build test
|
|
all-release: build-release test-release
|
|
|
|
[group('house-keeping')]
|
|
genDemo:
|
|
fish_prompt="> " fish_history="eza_history" vhs < docs/tapes/demo.tape
|
|
nsxiv -a docs/images/demo.gif
|
|
|
|
#----------#
|
|
# building #
|
|
#----------#
|
|
|
|
# compile the exa binary
|
|
[group('building')]
|
|
@build:
|
|
cargo build
|
|
|
|
# compile the exa binary (in release mode)
|
|
[group('building')]
|
|
@build-release:
|
|
cargo build --release --verbose
|
|
|
|
# produce an HTML chart of compilation timings
|
|
[group('building')]
|
|
@build-time:
|
|
cargo +nightly clean
|
|
cargo +nightly build -Z timings
|
|
|
|
# check that the exa binary can compile
|
|
[group('building')]
|
|
@check:
|
|
cargo check
|
|
|
|
|
|
#---------------#
|
|
# running tests #
|
|
#---------------#
|
|
|
|
# run unit tests
|
|
[group('testing')]
|
|
@test:
|
|
cargo test --workspace -- --quiet
|
|
|
|
# run unit tests (in release mode)
|
|
[group('testing')]
|
|
@test-release:
|
|
cargo test --workspace --release --verbose
|
|
|
|
#-----------------------#
|
|
# code quality and misc #
|
|
#-----------------------#
|
|
|
|
# lint the code
|
|
[group('house-keeping')]
|
|
@clippy:
|
|
touch src/main.rs
|
|
cargo clippy
|
|
|
|
# update dependency versions, and checks for outdated ones
|
|
[group('house-keeping')]
|
|
@update-deps:
|
|
cargo update
|
|
command -v cargo-outdated >/dev/null || (echo "cargo-outdated not installed" && exit 1)
|
|
cargo outdated
|
|
|
|
# list unused dependencies
|
|
[group('house-keeping')]
|
|
@unused-deps:
|
|
command -v cargo-udeps >/dev/null || (echo "cargo-udeps not installed" && exit 1)
|
|
cargo +nightly udeps
|
|
|
|
# check that every combination of feature flags is successful
|
|
[group('house-keeping')]
|
|
@check-features:
|
|
command -v cargo-hack >/dev/null || (echo "cargo-hack not installed" && exit 1)
|
|
cargo hack check --feature-powerset
|
|
|
|
# print versions of the necessary build tools
|
|
[group('house-keeping')]
|
|
@versions:
|
|
rustc --version
|
|
cargo --version
|
|
|
|
|
|
#---------------#
|
|
# documentation #
|
|
#---------------#
|
|
|
|
# build the man pages
|
|
[group('documentation')]
|
|
@man:
|
|
mkdir -p "${CARGO_TARGET_DIR:-target}/man"
|
|
version=$(awk 'BEGIN { FS = "\"" } ; /^version/ { print $2 ; exit }' Cargo.toml); \
|
|
for page in eza.1 eza_colors.5 eza_colors-explanation.5; do \
|
|
sed "s/\$version/v${version}/g" "man/${page}.md" | pandoc --standalone -f markdown -t man > "${CARGO_TARGET_DIR:-target}/man/${page}"; \
|
|
done;
|
|
|
|
# build and preview the main man page (eza.1)
|
|
[group('documentation')]
|
|
@man-1-preview: man
|
|
man "${CARGO_TARGET_DIR:-target}/man/eza.1"
|
|
|
|
# build and preview the colour configuration man page (eza_colors.5)
|
|
[group('documentation')]
|
|
@man-5-preview: man
|
|
man "${CARGO_TARGET_DIR:-target}/man/eza_colors.5"
|
|
|
|
# build and preview the colour configuration man page (eza_colors.5)
|
|
[group('documentation')]
|
|
@man-5-explanations-preview: man
|
|
man "${CARGO_TARGET_DIR:-target}/man/eza_colors-explanation.5"
|
|
|
|
#---------------#
|
|
# release #
|
|
#---------------#
|
|
|
|
new_version := "$(convco version --bump)"
|
|
|
|
# If you're not cafkafk and she isn't dead, don't run this!
|
|
#
|
|
# usage: release major, release minor, release patch
|
|
[group('release')]
|
|
release:
|
|
cargo bump "{{new_version}}"
|
|
git cliff -c .config/cliff.toml -t "{{new_version}}" > CHANGELOG.md
|
|
cargo check
|
|
nix build -L ./#clippy
|
|
git checkout -b "cafk-release-v{{new_version}}"
|
|
git commit -asm "chore: eza v{{new_version}} changelogs, version bump"
|
|
git push
|
|
@echo "waiting 10 seconds for github to catch up..."
|
|
sleep 10
|
|
gh pr create --draft --title "chore: release v{{new_version}}" --body "This PR was auto-generated by our lovely just file" --reviewer cafkafk
|
|
@echo "Now go review that and come back and run gh-release"
|
|
|
|
[group('release')]
|
|
@gh-release:
|
|
git tag -d "v{{new_version}}" || echo "tag not found, creating";
|
|
git tag --sign -a "v{{new_version}}" -m "auto generated by the justfile for eza v$(convco version)"
|
|
just cross
|
|
just mangen
|
|
just completions
|
|
mkdir -p ./target/"release-notes-$(convco version)"
|
|
git cliff -c .config/cliff.toml -t "v$(convco version)" --current > ./target/"release-notes-$(convco version)/RELEASE.md"
|
|
just checksum >> ./target/"release-notes-$(convco version)/RELEASE.md"
|
|
|
|
git push origin "v{{new_version}}"
|
|
gh release create "v$(convco version)" --target "$(git rev-parse HEAD)" --title "eza v$(convco version)" -d -F ./target/"release-notes-$(convco version)/RELEASE.md" ./target/"bin-$(convco version)"/* ./target/"man-$(convco version).tar.gz" ./target/"completions-$(convco version).tar.gz"
|
|
|
|
#----------------#
|
|
# binaries #
|
|
#----------------#
|
|
|
|
# TODO: make static/no_static DRY
|
|
# TODO: add name prefix/suffix arguments
|
|
|
|
[group('binaries')]
|
|
tar BINARY TARGET:
|
|
tar czvf ./target/"bin-$(convco version)"/{{BINARY}}_{{TARGET}}.tar.gz -C ./target/{{TARGET}}/release/ ./{{BINARY}}
|
|
|
|
[group('binaries')]
|
|
zip BINARY TARGET:
|
|
zip -j ./target/"bin-$(convco version)"/{{BINARY}}_{{TARGET}}.zip ./target/{{TARGET}}/release/{{BINARY}}
|
|
|
|
[group('binaries')]
|
|
tar_static BINARY TARGET:
|
|
tar czvf ./target/"bin-$(convco version)"/{{BINARY}}_{{TARGET}}_static.tar.gz -C ./target/{{TARGET}}/release/ ./{{BINARY}}
|
|
|
|
[group('binaries')]
|
|
zip_static BINARY TARGET:
|
|
zip -j ./target/"bin-$(convco version)"/{{BINARY}}_{{TARGET}}_static.zip ./target/{{TARGET}}/release/{{BINARY}}
|
|
|
|
[group('binaries')]
|
|
tar_no_libgit BINARY TARGET:
|
|
tar czvf ./target/"bin-$(convco version)"/{{BINARY}}_{{TARGET}}_no_libgit.tar.gz -C ./target/{{TARGET}}/release/ ./{{BINARY}}
|
|
|
|
[group('binaries')]
|
|
zip_no_libgit BINARY TARGET:
|
|
zip -j ./target/"bin-$(convco version)"/{{BINARY}}_{{TARGET}}_no_libgit.zip ./target/{{TARGET}}/release/{{BINARY}}
|
|
|
|
[group('binaries')]
|
|
tar_static_no_libgit BINARY TARGET:
|
|
tar czvf ./target/"bin-$(convco version)"/{{BINARY}}_{{TARGET}}_static_no_libgit.tar.gz -C ./target/{{TARGET}}/release/ ./{{BINARY}}
|
|
|
|
[group('binaries')]
|
|
zip_static_no_libgit BINARY TARGET:
|
|
zip -j ./target/"bin-$(convco version)"/{{BINARY}}_{{TARGET}}_static_no_libgit.zip ./target/{{TARGET}}/release/{{BINARY}}
|
|
|
|
[group('binaries')]
|
|
binary BINARY TARGET:
|
|
rustup target add {{TARGET}}
|
|
cross build --release --target {{TARGET}}
|
|
just tar {{BINARY}} {{TARGET}}
|
|
just zip {{BINARY}} {{TARGET}}
|
|
|
|
[group('binaries')]
|
|
binary_static BINARY TARGET:
|
|
rustup target add {{TARGET}}
|
|
RUSTFLAGS='-C target-feature=+crt-static' cross build --release --target {{TARGET}}
|
|
just tar_static {{BINARY}} {{TARGET}}
|
|
just zip_static {{BINARY}} {{TARGET}}
|
|
|
|
[group('binaries')]
|
|
binary_no_libgit BINARY TARGET:
|
|
rustup target add {{TARGET}}
|
|
cross build --no-default-features --release --target {{TARGET}}
|
|
just tar_no_libgit {{BINARY}} {{TARGET}}
|
|
just zip_no_libgit {{BINARY}} {{TARGET}}
|
|
|
|
[group('binaries')]
|
|
binary_static_no_libgit BINARY TARGET:
|
|
rustup target add {{TARGET}}
|
|
RUSTFLAGS='-C target-feature=+crt-static' cross build --no-default-features --release --target {{TARGET}}
|
|
just tar_static_no_libgit {{BINARY}} {{TARGET}}
|
|
just zip_static_no_libgit {{BINARY}} {{TARGET}}
|
|
|
|
[group('binaries')]
|
|
checksum:
|
|
@echo "# Checksums"
|
|
@echo "## sha256sum"
|
|
@echo '```'
|
|
@sha256sum ./target/"bin-$(convco version)"/*
|
|
@echo '```'
|
|
@echo "## md5sum"
|
|
@echo '```'
|
|
@md5sum ./target/"bin-$(convco version)"/*
|
|
@echo '```'
|
|
@echo "## blake3sum"
|
|
@echo '```'
|
|
@b3sum ./target/"bin-$(convco version)"/*
|
|
@echo '```'
|
|
|
|
alias c := cross
|
|
|
|
# Generate release binaries for EZA
|
|
#
|
|
# usage: cross
|
|
[group('binaries')]
|
|
@cross:
|
|
# Setup Output Directory
|
|
mkdir -p ./target/"bin-$(convco version)"
|
|
|
|
# Install Toolchains/Targets
|
|
rustup toolchain install stable
|
|
|
|
## Linux
|
|
### x86
|
|
just binary eza x86_64-unknown-linux-gnu
|
|
# just binary_static eza x86_64-unknown-linux-gnu
|
|
just binary eza x86_64-unknown-linux-musl
|
|
# just binary_static eza x86_64-unknown-linux-musl
|
|
|
|
### aarch
|
|
just binary eza aarch64-unknown-linux-gnu
|
|
just binary_no_libgit eza aarch64-unknown-linux-gnu
|
|
# BUG: just binary_static eza aarch64-unknown-linux-gnu
|
|
|
|
### arm
|
|
just binary eza arm-unknown-linux-gnueabihf
|
|
just binary_no_libgit eza arm-unknown-linux-gnueabihf
|
|
# just binary_static eza arm-unknown-linux-gnueabihf
|
|
|
|
## MacOS
|
|
# TODO: just binary eza x86_64-apple-darwin
|
|
|
|
## Windows
|
|
### x86
|
|
just binary eza.exe x86_64-pc-windows-gnu
|
|
# just binary_static eza.exe x86_64-pc-windows-gnu
|
|
# TODO: just binary eza.exe x86_64-pc-windows-gnullvm
|
|
# TODO: just binary eza.exe x86_64-pc-windows-msvc
|
|
|
|
# Generate Checksums
|
|
# TODO: moved to gh-release just checksum
|
|
|
|
[group('documentation')]
|
|
@mangen:
|
|
# Setup Output Directory
|
|
mkdir -p ./target/"man-$(convco version)"
|
|
pandoc --standalone -f markdown -t man man/eza.1.md > ./target/"man-$(convco version)"/eza.1
|
|
pandoc --standalone -f markdown -t man man/eza_colors.5.md > ./target/"man-$(convco version)"/eza_colors.5
|
|
pandoc --standalone -f markdown -t man man/eza_colors-explanation.5.md > ./target/"man-$(convco version)"/eza_colors-explanation.5
|
|
tar czvf ./target/"man-$(convco version)".tar.gz ./target/"man-$(convco version)"
|
|
|
|
[group('documentation')]
|
|
[group('binaries')]
|
|
@completions:
|
|
# Setup Output Directory
|
|
mkdir -p ./target/"completions-$(convco version)"
|
|
cp completions/*/* ./target/"completions-$(convco version)"/
|
|
tar czvf ./target/"completions-$(convco version)".tar.gz ./target/"completions-$(convco version)"
|
|
|
|
|
|
#---------------------#
|
|
# Integration testing #
|
|
#---------------------#
|
|
|
|
alias gen := gen_test_dir
|
|
|
|
test_dir := "tests/test_dir"
|
|
|
|
[group('testing')]
|
|
gen_test_dir:
|
|
bash devtools/dir-generator.sh {{ test_dir }}
|
|
|
|
# Runs integration tests in nix sandbox
|
|
#
|
|
# Required nix, likely won't work on windows.
|
|
[group('testing')]
|
|
@itest:
|
|
nix build -L ./#trycmd-local
|
|
|
|
# Runs integration tests in nix sandbox, and dumps outputs.
|
|
#
|
|
# WARNING: this can cause loss of work
|
|
[group('testing')]
|
|
@idump:
|
|
rm ./tests/gen/*_nix.stderr -f || echo
|
|
rm ./tests/gen/*_nix.stdout -f || echo
|
|
rm ./tests/gen/*_unix.stderr -f || echo
|
|
rm ./tests/gen/*_unix.stdout -f || echo
|
|
rm ./tests/ptests/ptest_*.stderr -f || echo
|
|
rm ./tests/ptests/ptest_*.stdout -f || echo
|
|
|
|
nix build -L ./#trydump
|
|
|
|
find result/dump -type f \( -name "*.stdout" -o -name "*.stderr" \) -exec sh -c 'base=$(basename {}); if [ -e "tests/gen/${base%.*}.toml" ]; then cp {} tests/gen/; elif [ -e "tests/cmd/${base%.*}.toml" ]; then cp {} tests/cmd/; elif [ -e "tests/ptests/${base%.*}.toml" ]; then cp {} tests/ptests/; fi' \;
|
|
|
|
[group('testing')]
|
|
@itest-gen:
|
|
nix build -L ./#trycmd
|
|
|
|
# Fully re-generates the integration tests using powertest
|
|
[group('testing')]
|
|
@regen:
|
|
which powertest >&- 2>&- || (echo -e "Powertest not installed. Please Clone the repo and run:\n\tcargo install --path . --locked" && exit 1)
|
|
echo "WARNING: this will delete all tests in tests/ptest"
|
|
sleep 5
|
|
echo "Deleting tests/ptests"
|
|
rm -rf tests/ptests
|
|
echo "Generating tests/ptests"
|
|
powertest
|
|
nix build -L ./#trydump
|
|
find result/dump -type f \( -name "*.stdout" -o -name "*.stderr" \) -exec sh -c 'base=$(basename {}); if [ -e "tests/ptests/${base%.*}.toml" ]; then cp {} tests/ptests/; fi' \;
|
|
|