283 lines
13 KiB
Makefile
283 lines
13 KiB
Makefile
.PHONY: prebuild clean cleanall ci server server-mac server-linux server-win server-linux-package generate watch-server webapp mac-app win-app-wpf linux-app modd-precheck templates-archive
|
|
|
|
PACKAGE_FOLDER = focalboard
|
|
|
|
# Build Flags
|
|
BUILD_NUMBER ?= $(BUILD_NUMBER:)
|
|
BUILD_DATE = $(shell date -u)
|
|
BUILD_HASH = $(shell git rev-parse HEAD)
|
|
# If we don't set the build number it defaults to dev
|
|
ifeq ($(BUILD_NUMBER),)
|
|
BUILD_NUMBER := dev
|
|
BUILD_DATE := n/a
|
|
endif
|
|
|
|
BUILD_TAGS += json1 sqlite3
|
|
|
|
LDFLAGS += -X "github.com/mattermost/focalboard/server/model.BuildNumber=$(BUILD_NUMBER)"
|
|
LDFLAGS += -X "github.com/mattermost/focalboard/server/model.BuildDate=$(BUILD_DATE)"
|
|
LDFLAGS += -X "github.com/mattermost/focalboard/server/model.BuildHash=$(BUILD_HASH)"
|
|
|
|
RACE = -race
|
|
|
|
ifeq ($(OS),Windows_NT)
|
|
RACE := ''
|
|
endif
|
|
|
|
# MAC cpu architecture
|
|
ifeq ($(shell uname -m),arm64)
|
|
MAC_GO_ARCH := arm64
|
|
else
|
|
MAC_GO_ARCH := amd64
|
|
endif
|
|
|
|
all: webapp server ## Build server and webapp.
|
|
|
|
prebuild: ## Run prebuild actions (install dependencies etc.).
|
|
cd webapp; npm install
|
|
cd mattermost-plugin/webapp; npm install
|
|
|
|
ci: webapp-ci server-test ## Simulate CI, locally.
|
|
|
|
setup-go-work: export EXCLUDE_ENTERPRISE ?= true
|
|
setup-go-work: ## Sets up a go.work file
|
|
go run ./build/gowork/main.go
|
|
|
|
templates-archive: setup-go-work ## Build templates archive file
|
|
cd server/assets/build-template-archive; go run -tags '$(BUILD_TAGS)' main.go --dir="../templates-boardarchive" --out="../templates.boardarchive"
|
|
|
|
server: setup-go-work ## Build server for local environment.
|
|
$(eval LDFLAGS += -X "github.com/mattermost/focalboard/server/model.Edition=dev")
|
|
cd server; go build -ldflags '$(LDFLAGS)' -tags '$(BUILD_TAGS)' -o ../bin/focalboard-server ./main
|
|
|
|
server-mac: setup-go-work ## Build server for Mac.
|
|
mkdir -p bin/mac
|
|
$(eval LDFLAGS += -X "github.com/mattermost/focalboard/server/model.Edition=mac")
|
|
ifeq ($(FB_PROD),)
|
|
cd server; env GOOS=darwin GOARCH=$(MAC_GO_ARCH) go build -ldflags '$(LDFLAGS)' -tags '$(BUILD_TAGS)' -o ../bin/mac/focalboard-server ./main
|
|
else
|
|
# Always build x86 for production, to work on both Apple Silicon and legacy Macs
|
|
cd server; env GOOS=darwin GOARCH=amd64 CGO_ENABLED=1 go build -ldflags '$(LDFLAGS)' -tags '$(BUILD_TAGS)' -o ../bin/mac/focalboard-server ./main
|
|
endif
|
|
|
|
server-linux: setup-go-work ## Build server for Linux.
|
|
mkdir -p bin/linux
|
|
$(eval LDFLAGS += -X "github.com/mattermost/focalboard/server/model.Edition=linux")
|
|
cd server; env GOOS=linux GOARCH=amd64 go build -ldflags '$(LDFLAGS)' -tags '$(BUILD_TAGS)' -o ../bin/linux/focalboard-server ./main
|
|
|
|
server-docker: setup-go-work ## Build server for Docker Architectures.
|
|
mkdir -p bin/docker
|
|
$(eval LDFLAGS += -X "github.com/mattermost/focalboard/server/model.Edition=linux")
|
|
cd server; env GOOS=$(os) GOARCH=$(arch) go build -ldflags '$(LDFLAGS)' -tags '$(BUILD_TAGS)' -o ../bin/docker/focalboard-server ./main
|
|
|
|
server-win: setup-go-work ## Build server for Windows.
|
|
$(eval LDFLAGS += -X "github.com/mattermost/focalboard/server/model.Edition=win")
|
|
cd server; env GOOS=windows GOARCH=amd64 go build -ldflags '$(LDFLAGS)' -tags '$(BUILD_TAGS)' -o ../bin/win/focalboard-server.exe ./main
|
|
|
|
server-dll: setup-go-work ## Build server as Windows DLL.
|
|
$(eval LDFLAGS += -X "github.com/mattermost/focalboard/server/model.Edition=win")
|
|
cd server; env GOOS=windows GOARCH=amd64 go build -ldflags '$(LDFLAGS)' -tags '$(BUILD_TAGS)' -buildmode=c-shared -o ../bin/win-dll/focalboard-server.dll ./main
|
|
|
|
server-linux-package: server-linux webapp
|
|
rm -rf package
|
|
mkdir -p package/${PACKAGE_FOLDER}/bin
|
|
cp bin/linux/focalboard-server package/${PACKAGE_FOLDER}/bin
|
|
cp -R webapp/pack package/${PACKAGE_FOLDER}/pack
|
|
cp server-config.json package/${PACKAGE_FOLDER}/config.json
|
|
cp build/MIT-COMPILED-LICENSE.md package/${PACKAGE_FOLDER}
|
|
cp NOTICE.txt package/${PACKAGE_FOLDER}
|
|
cp webapp/NOTICE.txt package/${PACKAGE_FOLDER}/webapp-NOTICE.txt
|
|
mkdir -p dist
|
|
cd package && tar -czvf ../dist/focalboard-server-linux-amd64.tar.gz ${PACKAGE_FOLDER}
|
|
rm -rf package
|
|
|
|
server-linux-package-docker:
|
|
rm -rf package
|
|
mkdir -p package/${PACKAGE_FOLDER}/bin
|
|
cp bin/linux/focalboard-server package/${PACKAGE_FOLDER}/bin
|
|
cp -R webapp/pack package/${PACKAGE_FOLDER}/pack
|
|
cp server-config.json package/${PACKAGE_FOLDER}/config.json
|
|
cp build/MIT-COMPILED-LICENSE.md package/${PACKAGE_FOLDER}
|
|
cp NOTICE.txt package/${PACKAGE_FOLDER}
|
|
cp webapp/NOTICE.txt package/${PACKAGE_FOLDER}/webapp-NOTICE.txt
|
|
mkdir -p dist
|
|
cd package && tar -czvf ../dist/focalboard-server-linux-amd64.tar.gz ${PACKAGE_FOLDER}
|
|
rm -rf package
|
|
|
|
generate: ## Install and run code generators.
|
|
cd server; go install github.com/golang/mock/mockgen@v1.6.0
|
|
cd server; go generate ./...
|
|
|
|
server-lint: setup-go-work ## Run linters on server code.
|
|
@if ! [ -x "$$(command -v golangci-lint)" ]; then \
|
|
echo "golangci-lint is not installed. Please see https://github.com/golangci/golangci-lint#install-golangci-lint for installation instructions."; \
|
|
exit 1; \
|
|
fi;
|
|
cd server; golangci-lint run ./...
|
|
cd mattermost-plugin; golangci-lint run ./...
|
|
|
|
modd-precheck:
|
|
@if ! [ -x "$$(command -v modd)" ]; then \
|
|
echo "modd is not installed. Please see https://github.com/cortesi/modd#install for installation instructions"; \
|
|
exit 1; \
|
|
fi; \
|
|
|
|
watch: modd-precheck ## Run both server and webapp watching for changes
|
|
env FOCALBOARD_BUILD_TAGS='$(BUILD_TAGS)' modd
|
|
|
|
watch-single-user: modd-precheck ## Run both server and webapp in single user mode watching for changes
|
|
env FOCALBOARDSERVER_ARGS=--single-user FOCALBOARD_BUILD_TAGS='$(BUILD_TAGS)' modd
|
|
|
|
watch-server-test: modd-precheck ## Run server tests watching for changes
|
|
env FOCALBOARD_BUILD_TAGS='$(BUILD_TAGS)' modd -f modd-servertest.conf
|
|
|
|
server-test: server-test-sqlite server-test-mysql server-test-mariadb server-test-postgres ## Run server tests
|
|
|
|
server-test-sqlite: export FOCALBOARD_UNIT_TESTING=1
|
|
|
|
server-test-sqlite: setup-go-work ## Run server tests using sqlite
|
|
cd server; go test -tags '$(BUILD_TAGS)' -race -v -coverpkg=./... -coverprofile=server-sqlite-profile.coverage -count=1 -timeout=30m ./...
|
|
cd server; go tool cover -func server-sqlite-profile.coverage
|
|
|
|
server-test-mini-sqlite: export FOCALBOARD_UNIT_TESTING=1
|
|
|
|
server-test-mini-sqlite: setup-go-work ## Run server tests using sqlite
|
|
cd server/integrationtests; go test -tags '$(BUILD_TAGS)' $(RACE) -v -count=1 -timeout=30m ./...
|
|
|
|
server-test-mysql: export FOCALBOARD_UNIT_TESTING=1
|
|
server-test-mysql: export FOCALBOARD_STORE_TEST_DB_TYPE=mysql
|
|
server-test-mysql: export FOCALBOARD_STORE_TEST_DOCKER_PORT=44446
|
|
|
|
server-test-mysql: setup-go-work ## Run server tests using mysql
|
|
@echo Starting docker container for mysql
|
|
docker-compose -f ./docker-testing/docker-compose-mysql.yml down -v --remove-orphans
|
|
docker-compose -f ./docker-testing/docker-compose-mysql.yml run start_dependencies
|
|
cd server; go test -tags '$(BUILD_TAGS)' -race -v -coverpkg=./... -coverprofile=server-mysql-profile.coverage -count=1 -timeout=30m ./...
|
|
cd server; go tool cover -func server-mysql-profile.coverage
|
|
cd mattermost-plugin/server; go test -tags '$(BUILD_TAGS)' -race -v -coverpkg=./... -coverprofile=plugin-mysql-profile.coverage -count=1 -timeout=30m ./...
|
|
cd mattermost-plugin/server; go tool cover -func plugin-mysql-profile.coverage
|
|
docker-compose -f ./docker-testing/docker-compose-mysql.yml down -v --remove-orphans
|
|
|
|
server-test-mariadb: export FOCALBOARD_UNIT_TESTING=1
|
|
server-test-mariadb: export FOCALBOARD_STORE_TEST_DB_TYPE=mariadb
|
|
server-test-mariadb: export FOCALBOARD_STORE_TEST_DOCKER_PORT=44445
|
|
|
|
server-test-mariadb: templates-archive ## Run server tests using mysql
|
|
@echo Starting docker container for mariadb
|
|
docker-compose -f ./docker-testing/docker-compose-mariadb.yml down -v --remove-orphans
|
|
docker-compose -f ./docker-testing/docker-compose-mariadb.yml run start_dependencies
|
|
cd server; go test -tags '$(BUILD_TAGS)' -race -v -coverpkg=./... -coverprofile=server-mariadb-profile.coverage -count=1 -timeout=30m ./...
|
|
cd server; go tool cover -func server-mariadb-profile.coverage
|
|
cd mattermost-plugin/server; go test -tags '$(BUILD_TAGS)' -race -v -coverpkg=./... -coverprofile=plugin-mariadb-profile.coverage -count=1 -timeout=30m ./...
|
|
cd mattermost-plugin/server; go tool cover -func plugin-mariadb-profile.coverage
|
|
docker-compose -f ./docker-testing/docker-compose-mariadb.yml down -v --remove-orphans
|
|
|
|
server-test-postgres: export FOCALBOARD_UNIT_TESTING=1
|
|
server-test-postgres: export FOCALBOARD_STORE_TEST_DB_TYPE=postgres
|
|
server-test-postgres: export FOCALBOARD_STORE_TEST_DOCKER_PORT=44447
|
|
|
|
server-test-postgres: setup-go-work ## Run server tests using postgres
|
|
@echo Starting docker container for postgres
|
|
docker-compose -f ./docker-testing/docker-compose-postgres.yml down -v --remove-orphans
|
|
docker-compose -f ./docker-testing/docker-compose-postgres.yml run start_dependencies
|
|
cd server; go test -tags '$(BUILD_TAGS)' -race -v -coverpkg=./... -coverprofile=server-postgres-profile.coverage -count=1 -timeout=30m ./...
|
|
cd server; go tool cover -func server-postgres-profile.coverage
|
|
cd mattermost-plugin/server; go test -tags '$(BUILD_TAGS)' -race -v -coverpkg=./... -coverprofile=plugin-postgres-profile.coverage -count=1 -timeout=30m ./...
|
|
cd mattermost-plugin/server; go tool cover -func plugin-postgres-profile.coverage
|
|
docker-compose -f ./docker-testing/docker-compose-postgres.yml down -v --remove-orphans
|
|
|
|
webapp: ## Build webapp.
|
|
cd webapp; npm run pack
|
|
|
|
webapp-ci: ## Webapp CI: linting & testing.
|
|
cd webapp; npm run check
|
|
cd mattermost-plugin/webapp; npm run lint
|
|
cd webapp; npm run test
|
|
cd mattermost-plugin/webapp; npm run test
|
|
cd webapp; npm run cypress:ci
|
|
|
|
webapp-test: ## jest tests for webapp
|
|
cd webapp; npm run test
|
|
|
|
watch-plugin: modd-precheck ## Run and upload the plugin to a development server
|
|
env FOCALBOARD_BUILD_TAGS='$(BUILD_TAGS)' modd -f modd-watchplugin.conf
|
|
|
|
live-watch-plugin: modd-precheck ## Run and update locally the plugin in the development server
|
|
cd mattermost-plugin; make live-watch
|
|
|
|
.PHONY: build-product
|
|
build-product: ## Builds the product as something the Mattermost server will pull files from when packaging a release
|
|
cd mattermost-plugin; make build-product
|
|
|
|
.PHONY: watch-product
|
|
watch-product: ## Run the product as something the Mattermost web app will watch for
|
|
cd mattermost-plugin; make watch-product
|
|
|
|
mac-app: server-mac webapp ## Build Mac application.
|
|
rm -rf mac/temp
|
|
rm -rf mac/dist
|
|
rm -rf mac/resources/bin
|
|
rm -rf mac/resources/pack
|
|
mkdir -p mac/resources/bin
|
|
cp bin/mac/focalboard-server mac/resources/bin/focalboard-server
|
|
cp app-config.json mac/resources/config.json
|
|
cp -R webapp/pack mac/resources/pack
|
|
mkdir -p mac/temp
|
|
xcodebuild archive -workspace mac/Focalboard.xcworkspace -scheme Focalboard -archivePath mac/temp/focalboard.xcarchive CODE_SIGN_IDENTITY="" CODE_SIGNING_REQUIRED="NO" CODE_SIGNING_ALLOWED="NO" \
|
|
|| { echo "xcodebuild failed, did you install the full Xcode and not just the CLI tools?"; exit 1; }
|
|
mkdir -p mac/dist
|
|
cp -R mac/temp/focalboard.xcarchive/Products/Applications/Focalboard.app mac/dist/
|
|
# xcodebuild -exportArchive -archivePath mac/temp/focalboard.xcarchive -exportPath mac/dist -exportOptionsPlist mac/export.plist
|
|
cp build/MIT-COMPILED-LICENSE.md mac/dist
|
|
cp NOTICE.txt mac/dist
|
|
cp webapp/NOTICE.txt mac/dist/webapp-NOTICE.txt
|
|
cd mac/dist; zip -r focalboard-mac.zip Focalboard.app MIT-COMPILED-LICENSE.md NOTICE.txt webapp-NOTICE.txt
|
|
|
|
win-wpf-app: server-dll webapp ## Build Windows WPF application.
|
|
cd win-wpf && ./build.bat
|
|
cd win-wpf && ./package.bat
|
|
cd win-wpf && ./package-zip.bat
|
|
|
|
linux-app: webapp ## Build Linux application.
|
|
rm -rf linux/temp
|
|
rm -rf linux/dist
|
|
mkdir -p linux/dist
|
|
mkdir -p linux/temp/focalboard-app
|
|
cp app-config.json linux/temp/focalboard-app/config.json
|
|
cp build/MIT-COMPILED-LICENSE.md linux/temp/focalboard-app/
|
|
cp NOTICE.txt linux/temp/focalboard-app/
|
|
cp webapp/NOTICE.txt linux/temp/focalboard-app/webapp-NOTICE.txt
|
|
cp -R webapp/pack linux/temp/focalboard-app/pack
|
|
cd linux; make build
|
|
cp -R linux/bin/focalboard-app linux/temp/focalboard-app/
|
|
cd linux/temp; tar -zcf ../dist/focalboard-linux.tar.gz focalboard-app
|
|
rm -rf linux/temp
|
|
|
|
swagger: ## Generate swagger API spec and clients based on it.
|
|
mkdir -p server/swagger/docs
|
|
mkdir -p server/swagger/clients
|
|
cd server && swagger generate spec -m -o ./swagger/swagger.yml
|
|
|
|
cd server/swagger && openapi-generator generate -i swagger.yml -g html2 -o docs/html
|
|
cd server/swagger && openapi-generator generate -i swagger.yml -g go -o clients/go
|
|
cd server/swagger && openapi-generator generate -i swagger.yml -g javascript -o clients/javascript
|
|
cd server/swagger && openapi-generator generate -i swagger.yml -g typescript-fetch -o clients/typescript
|
|
cd server/swagger && openapi-generator generate -i swagger.yml -g swift5 -o clients/swift
|
|
cd server/swagger && openapi-generator generate -i swagger.yml -g python -o clients/python
|
|
|
|
clean: ## Clean build artifacts.
|
|
rm -rf bin
|
|
rm -rf dist
|
|
rm -rf webapp/pack
|
|
rm -rf mac/temp
|
|
rm -rf mac/dist
|
|
rm -rf linux/dist
|
|
rm -rf win-wpf/msix
|
|
rm -f win-wpf/focalboard.msix
|
|
|
|
cleanall: clean ## Clean all build artifacts and dependencies.
|
|
rm -rf webapp/node_modules
|
|
|
|
## Help documentatin à la https://marmelab.com/blog/2016/02/29/auto-documented-makefile.html
|
|
help:
|
|
@grep -E '^[0-9a-zA-Z_-]+:.*?## .*$$' ./Makefile | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
|