Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

makefile: Add uninstall target + add check arg #5129

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

makefile: Add uninstall target + add check arg #5129

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
affae6f
update Makefile
alindt Dec 30, 2024
033757d
add dev binary to .gitignore
alindt Dec 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,4 @@
/invidious
/sentry
/config/config.yml
/invidious-dev
66 changes: 45 additions & 21 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,10 @@ MT := 0


FLAGS ?=
CRYSTAL_BIN ?= crystal
SHARDS_BIN ?= shards


# Build flags configuration
ifeq ($(RELEASE), 1)
FLAGS += --release
endif
Expand All @@ -28,7 +30,6 @@ ifeq ($(MT), 1)
FLAGS += -Dpreview_mt
endif


ifeq ($(NO_DBG_SYMBOLS), 1)
FLAGS += --no-debug
else
Expand All @@ -39,60 +40,77 @@ ifeq ($(API_ONLY), 1)
FLAGS += -Dapi_only
endif

# Development flags
DEVFLAGS := --progress --stats --time

# Output binary name
BINARY_NAME := invidious
BINARY_DEV := $(BINARY_NAME)-dev

# -----------------------
# Main
# -----------------------

all: invidious
.DEFAULT_GOAL := all

all: $(BINARY_NAME)

get-libs:
shards install --production
$(SHARDS_BIN) install --production

# TODO: add support for ARM64 via cross-compilation
invidious: get-libs
crystal build src/invidious.cr $(FLAGS) --progress --stats --error-trace
$(BINARY_NAME): get-libs
$(CRYSTAL_BIN) build src/$(BINARY_NAME).cr $(FLAGS) --progress --stats --error-trace


run: invidious
./invidious
run: $(BINARY_NAME)
./$(BINARY_NAME)


# -----------------------
# Development
# -----------------------


format:
crystal tool format
$(CRYSTAL_BIN) tool format --check
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would prefer to have a separate arg for --check

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Separate arg or a different target altogether maybe?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not very familiar with makefiles but I guess separate arg


test:
crystal spec
$(CRYSTAL_BIN) spec

verify:
crystal build src/invidious.cr -Dskip_videojs_download \
$(CRYSTAL_BIN) build src/$(BINARY_NAME).cr -Dskip_videojs_download \
--no-codegen --progress --stats --error-trace

dev-build: get-libs
$(CRYSTAL_BIN) build src/$(BINARY_NAME).cr $(DEVFLAGS) -o $(BINARY_DEV)

dev-run: dev-build
INVIDIOUS_CONFIG_FILE=config/config-dev.yml ./$(BINARY_DEV)

# -----------------------
# (Un)Install
# -----------------------

# TODO
PREFIX ?= /usr/local
DESTDIR ?=

install: $(BINARY_NAME)
install -d $(DESTDIR)$(PREFIX)/bin
install -m 755 $(BINARY_NAME) $(DESTDIR)$(PREFIX)/bin/

uninstall:
rm -f $(DESTDIR)$(PREFIX)/bin/$(BINARY_NAME)

# -----------------------
# Cleaning
# -----------------------

clean:
rm invidious
rm -f $(BINARY_NAME) $(BINARY_DEV)

distclean: clean
rm -rf libs
rm -rf ~/.cache/{crystal,shards}


# -----------------------
# Help page
# -----------------------
Expand All @@ -101,14 +119,17 @@ help:
@echo "Targets available in this Makefile:"
@echo ""
@echo " get-libs Fetch Crystal libraries"
@echo " invidious Build Invidious"
@echo " $(BINARY_NAME) Build Invidious"
@echo " run Launch Invidious"
@echo ""
@echo " format Run the Crystal formatter"
@echo " test Run tests"
@echo " verify Just make sure that the code compiles, but without"
@echo " generating any binaries. Useful to search for errors"
@echo ""
@echo " install Install Invidious to system"
@echo " uninstall Remove Invidious from system"
@echo ""
@echo " clean Remove build artifacts"
@echo " distclean Remove build artifacts and libraries"
@echo ""
Expand All @@ -120,9 +141,12 @@ help:
@echo ""
@echo " API_ONLY Build invidious without a GUI (Default: 0)"
@echo " NO_DBG_SYMBOLS Strip debug symbols (Default: 0)"


@echo ""
@echo "Installation options:"
@echo " PREFIX Installation prefix (Default: /usr/local)"
@echo " DESTDIR Destination directory (Default: empty)"

# No targets generates an output named after themselves
.PHONY: all get-libs build amd64 run
.PHONY: format test verify clean distclean help
.PHONY: all get-libs build run
.PHONY: format test verify dev-build dev-run
.PHONY: install uninstall clean distclean help
Loading