-# Shaarli, the personal, minimalist, super-fast, no-database delicious clone.
-# Makefile for PHP code analysis & testing
+# The personal, minimalist, super-fast, database free, bookmarking service.
+# Makefile for PHP code analysis & testing, documentation and release generation
# Prerequisites:
# - install Composer, either:
PHP_SOURCE = index.php application tests plugins
PHP_COMMA_SOURCE = index.php,application,tests,plugins
-all: static_analysis_summary test
+all: static_analysis_summary check_permissions test
##
# Concise status of the project
printf "$$warnings\t$$rule\n"; \
done;
+##
+# Checks source file & script permissions
+##
+check_permissions:
+ @echo "----------------------"
+ @echo "Check file permissions"
+ @echo "----------------------"
+ @for file in `git ls-files`; do \
+ if [ -x $$file ]; then \
+ errors=true; \
+ echo "$${file} is executable"; \
+ fi \
+ done; [ -z $$errors ] || false
+
##
# PHPUnit
# Runs unitary and functional tests
@echo "-------"
@echo "PHPUNIT"
@echo "-------"
+ @mkdir -p sandbox
@$(BIN)/phpunit tests
+##
+# Custom release archive generation
+#
+# For each tagged revision, GitHub provides tar and zip archives that correspond
+# to the output of git-archive
+#
+# These targets produce similar archives, featuring 3rd-party dependencies
+# to ease deployment on shared hosting.
+##
+ARCHIVE_VERSION := shaarli-$$(git describe)-full
+ARCHIVE_PREFIX=Shaarli/
+
+release_archive: release_tar release_zip
+
+### download 3rd-party PHP libraries
+composer_dependencies: clean
+ composer update --no-dev
+ find vendor/ -name ".git" -type d -exec rm -rf {} +
+
+### generate a release tarball and include 3rd-party dependencies
+release_tar: composer_dependencies
+ git archive --prefix=$(ARCHIVE_PREFIX) -o $(ARCHIVE_VERSION).tar HEAD
+ tar rvf $(ARCHIVE_VERSION).tar --transform "s|^vendor|$(ARCHIVE_PREFIX)vendor|" vendor/
+ gzip $(ARCHIVE_VERSION).tar
+
+### generate a release zip and include 3rd-party dependencies
+release_zip: composer_dependencies
+ git archive --prefix=$(ARCHIVE_PREFIX) -o $(ARCHIVE_VERSION).zip -9 HEAD
+ mkdir $(ARCHIVE_PREFIX)
+ rsync -a vendor/ $(ARCHIVE_PREFIX)vendor/
+ zip -r $(ARCHIVE_VERSION).zip $(ARCHIVE_PREFIX)vendor/
+ rm -rf $(ARCHIVE_PREFIX)
+
##
# Targets for repository and documentation maintenance
##
### remove all unversioned files
clean:
@git clean -df
+ @rm -rf sandbox
+
+### generate the AUTHORS file from Git commit information
+authors:
+ @cp .github/mailmap .mailmap
+ @git shortlog -sne > AUTHORS
+ @rm .mailmap
### generate Doxygen documentation
doxygen: clean
-o doc/$$base.html $$file; \
done;
-htmldoc: doc htmlsidebar htmlpages
+htmldoc: authors doc htmlsidebar htmlpages