230 lines
7.6 KiB
Makefile
230 lines
7.6 KiB
Makefile
GO ?= $(shell command -v go 2> /dev/null)
|
|
NPM ?= $(shell command -v npm 2> /dev/null)
|
|
CURL ?= $(shell command -v curl 2> /dev/null)
|
|
MANIFEST_FILE ?= plugin.json
|
|
GOPATH ?= $(shell go env GOPATH)
|
|
GO_TEST_FLAGS ?= -race
|
|
GO_BUILD_FLAGS ?=
|
|
MM_UTILITIES_DIR ?= ../mattermost-utilities
|
|
DEFAULT_GOOS := $(shell go env GOOS)
|
|
DEFAULT_GOARCH := $(shell go env GOARCH)
|
|
|
|
export GO111MODULE=on
|
|
|
|
# You can include assets this directory into the bundle. This can be e.g. used to include profile pictures.
|
|
ASSETS_DIR ?= assets
|
|
|
|
# Verify environment, and define PLUGIN_ID, PLUGIN_VERSION, HAS_SERVER and HAS_WEBAPP as needed.
|
|
include build/setup.mk
|
|
|
|
BUNDLE_NAME ?= $(PLUGIN_ID)-$(PLUGIN_VERSION).tar.gz
|
|
|
|
# Include custom makefile, if present
|
|
ifneq ($(wildcard build/custom.mk),)
|
|
include build/custom.mk
|
|
endif
|
|
|
|
ifneq ($(MM_DEBUG),)
|
|
GO_BUILD_GCFLAGS = -gcflags "all=-N -l"
|
|
else
|
|
GO_BUILD_GCFLAGS =
|
|
endif
|
|
|
|
|
|
## Checks the code style, tests, builds and bundles the plugin.
|
|
all: check-style test dist
|
|
|
|
## Propagates plugin manifest information into the server/ and webapp/ folders as required.
|
|
.PHONY: apply
|
|
apply:
|
|
./build/bin/manifest apply
|
|
|
|
## Runs golangci-lint and eslint.
|
|
.PHONY: check-style
|
|
check-style: webapp/.npminstall golangci-lint
|
|
@echo Checking for style guide compliance
|
|
|
|
ifneq ($(HAS_WEBAPP),)
|
|
cd webapp && npm run lint
|
|
endif
|
|
|
|
## Run golangci-lint on codebase.
|
|
.PHONY: golangci-lint
|
|
golangci-lint:
|
|
@if ! [ -x "$$(command -v golangci-lint)" ]; then \
|
|
echo "golangci-lint is not installed. Please see https://github.com/golangci/golangci-lint#install for installation instructions."; \
|
|
exit 1; \
|
|
fi; \
|
|
|
|
@echo Running golangci-lint
|
|
golangci-lint run ./...
|
|
|
|
## Builds the server, if it exists, for all supported architectures, unless MM_SERVICESETTINGS_ENABLEDEVELOPER is set
|
|
.PHONY: server
|
|
server:
|
|
ifneq ($(HAS_SERVER),)
|
|
ifneq ($(MM_DEBUG),)
|
|
$(info DEBUG mode is on; to disable, unset MM_DEBUG)
|
|
endif
|
|
mkdir -p server/dist;
|
|
ifneq ($(MM_SERVICESETTINGS_ENABLEDEVELOPER),)
|
|
@echo Building plugin only for $(DEFAULT_GOOS)-$(DEFAULT_GOARCH) because MM_SERVICESETTINGS_ENABLEDEVELOPER is enabled
|
|
cd server && env CGO_ENABLED=0 $(GO) build $(GO_BUILD_FLAGS) $(GO_BUILD_GCFLAGS) -trimpath -o dist/plugin-$(DEFAULT_GOOS)-$(DEFAULT_GOARCH);
|
|
else
|
|
cd server && env CGO_ENABLED=0 GOOS=linux GOARCH=amd64 $(GO) build $(GO_BUILD_FLAGS) $(GO_BUILD_GCFLAGS) -trimpath -o dist/plugin-linux-amd64;
|
|
cd server && env CGO_ENABLED=0 GOOS=linux GOARCH=arm64 $(GO) build $(GO_BUILD_FLAGS) $(GO_BUILD_GCFLAGS) -trimpath -o dist/plugin-linux-arm64;
|
|
cd server && env CGO_ENABLED=0 GOOS=darwin GOARCH=amd64 $(GO) build $(GO_BUILD_FLAGS) $(GO_BUILD_GCFLAGS) -trimpath -o dist/plugin-darwin-amd64;
|
|
cd server && env CGO_ENABLED=0 GOOS=darwin GOARCH=arm64 $(GO) build $(GO_BUILD_FLAGS) $(GO_BUILD_GCFLAGS) -trimpath -o dist/plugin-darwin-arm64;
|
|
cd server && env CGO_ENABLED=0 GOOS=windows GOARCH=amd64 $(GO) build $(GO_BUILD_FLAGS) $(GO_BUILD_GCFLAGS) -trimpath -o dist/plugin-windows-amd64.exe;
|
|
endif
|
|
endif
|
|
|
|
## Ensures NPM dependencies are installed without having to run this all the time.
|
|
webapp/.npminstall:
|
|
ifneq ($(HAS_WEBAPP),)
|
|
cd webapp && $(NPM) install
|
|
touch $@
|
|
endif
|
|
|
|
## Builds the webapp, if it exists.
|
|
.PHONY: webapp
|
|
webapp: webapp/.npminstall
|
|
ifneq ($(HAS_WEBAPP),)
|
|
cd webapp && $(NPM) run build;
|
|
endif
|
|
|
|
## Builds the webapp in debug mode, if it exists.
|
|
.PHONY: webapp-debug
|
|
webapp-debug: webapp/.npminstall
|
|
ifneq ($(HAS_WEBAPP),)
|
|
cd webapp && \
|
|
$(NPM) run debug;
|
|
endif
|
|
|
|
# server-debug builds and deploys a debug version of the plugin for your architecture.
|
|
# Then resets the plugin to pick up the changes.
|
|
.PHONY: server-debug
|
|
server-debug: server-debug-deploy reset
|
|
|
|
.PHONY: server-debug-deploy
|
|
server-debug-deploy: validate-go-version
|
|
./build/bin/manifest apply
|
|
mkdir -p server/dist
|
|
ifeq ($(OS),Darwin)
|
|
cd server && env GOOS=darwin GOARCH=amd64 $(GOBUILD) -gcflags "all=-N -l" -o dist/plugin-darwin-amd64;
|
|
else ifeq ($(OS),Linux)
|
|
cd server && env GOOS=linux GOARCH=amd64 $(GOBUILD) -gcflags "all=-N -l" -o dist/plugin-linux-amd64;
|
|
else ifeq ($(OS),Windows_NT)
|
|
cd server && env GOOS=windows GOARCH=amd64 $(GOBUILD) -gcflags "all=-N -l" -o dist/plugin-windows-amd64.exe;
|
|
else
|
|
$(error make debug depends on uname to return your OS. If it does not return 'Darwin' (meaning OSX), 'Linux', or 'Windows_NT' (all recent versions of Windows), you will need to edit the Makefile for your own OS.)
|
|
endif
|
|
rm -rf dist/
|
|
mkdir -p dist/$(PLUGIN_ID)/server/dist
|
|
cp $(MANIFEST_FILE) dist/$(PLUGIN_ID)/
|
|
cp -r server/dist/* dist/$(PLUGIN_ID)/server/dist/
|
|
mkdir -p ../mattermost-server/plugins
|
|
cp -r dist/* ../mattermost-server/plugins/
|
|
|
|
.PHONY: validate-go-version
|
|
validate-go-version: ## Validates the installed version of go against Mattermost's minimum requirement.
|
|
@if [ $(GO_MAJOR_VERSION) -gt $(MINIMUM_SUPPORTED_GO_MAJOR_VERSION) ]; then \
|
|
exit 0 ;\
|
|
elif [ $(GO_MAJOR_VERSION) -lt $(MINIMUM_SUPPORTED_GO_MAJOR_VERSION) ]; then \
|
|
echo '$(GO_VERSION_VALIDATION_ERR_MSG)';\
|
|
exit 1; \
|
|
elif [ $(GO_MINOR_VERSION) -lt $(MINIMUM_SUPPORTED_GO_MINOR_VERSION) ] ; then \
|
|
echo '$(GO_VERSION_VALIDATION_ERR_MSG)';\
|
|
exit 1; \
|
|
fi
|
|
|
|
## Generates a tar bundle of the plugin for install.
|
|
.PHONY: bundle
|
|
bundle:
|
|
rm -rf dist/
|
|
mkdir -p dist/$(PLUGIN_ID)
|
|
cp $(MANIFEST_FILE) dist/$(PLUGIN_ID)/
|
|
ifneq ($(wildcard $(ASSETS_DIR)/.),)
|
|
cp -r $(ASSETS_DIR) dist/$(PLUGIN_ID)/
|
|
endif
|
|
ifneq ($(HAS_PUBLIC),)
|
|
cp -r public/ dist/$(PLUGIN_ID)/
|
|
endif
|
|
ifneq ($(HAS_SERVER),)
|
|
mkdir -p dist/$(PLUGIN_ID)/server/dist;
|
|
cp -r server/dist/* dist/$(PLUGIN_ID)/server/dist/;
|
|
endif
|
|
ifneq ($(HAS_WEBAPP),)
|
|
mkdir -p dist/$(PLUGIN_ID)/webapp/dist;
|
|
cp -r webapp/dist/* dist/$(PLUGIN_ID)/webapp/dist/;
|
|
endif
|
|
cd dist && tar -cvzf $(BUNDLE_NAME) $(PLUGIN_ID)
|
|
|
|
@echo plugin built at: dist/$(BUNDLE_NAME)
|
|
|
|
## Builds and bundles the plugin.
|
|
.PHONY: dist
|
|
dist: apply server webapp bundle
|
|
|
|
## Installs the plugin to a (development) server.
|
|
## It uses the API if appropriate environment variables are defined,
|
|
## and otherwise falls back to trying to copy the plugin to a sibling mattermost-server directory.
|
|
.PHONY: deploy
|
|
deploy: dist
|
|
./build/bin/deploy $(PLUGIN_ID) dist/$(BUNDLE_NAME)
|
|
|
|
.PHONY: debug-deploy
|
|
debug-deploy: debug-dist deploy
|
|
|
|
.PHONY: debug-dist
|
|
debug-dist: apply server webapp-debug bundle
|
|
|
|
## Runs any lints and unit tests defined for the server and webapp, if they exist.
|
|
.PHONY: test
|
|
test: webapp/.npminstall
|
|
ifneq ($(HAS_SERVER),)
|
|
$(GO) test -v $(GO_TEST_FLAGS) ./server/...
|
|
endif
|
|
ifneq ($(HAS_WEBAPP),)
|
|
cd webapp && $(NPM) run fix && $(NPM) run test;
|
|
endif
|
|
|
|
## Creates a coverage report for the server code.
|
|
.PHONY: coverage
|
|
coverage: webapp/.npminstall
|
|
ifneq ($(HAS_SERVER),)
|
|
$(GO) test $(GO_TEST_FLAGS) -coverprofile=server/coverage.txt ./server/...
|
|
$(GO) tool cover -html=server/coverage.txt
|
|
endif
|
|
|
|
## Extract strings for translation from the source code.
|
|
.PHONY: i18n-extract
|
|
i18n-extract:
|
|
ifneq ($(HAS_WEBAPP),)
|
|
ifeq ($(HAS_MM_UTILITIES),)
|
|
@echo "You must clone github.com/mattermost/mattermost-utilities repo in .. to use this command"
|
|
else
|
|
cd $(MM_UTILITIES_DIR) && npm install && npm run babel && node mmjstool/build/index.js i18n extract-webapp --webapp-dir $(PWD)/webapp
|
|
endif
|
|
endif
|
|
|
|
## Clean removes all build artifacts.
|
|
.PHONY: clean
|
|
clean:
|
|
rm -fr dist/
|
|
ifneq ($(HAS_SERVER),)
|
|
rm -fr server/coverage.txt
|
|
rm -fr server/dist
|
|
endif
|
|
ifneq ($(HAS_WEBAPP),)
|
|
rm -fr webapp/.npminstall
|
|
rm -fr webapp/junit.xml
|
|
rm -fr webapp/dist
|
|
rm -fr webapp/node_modules
|
|
endif
|
|
rm -fr build/bin/
|
|
|
|
# Help documentation à la https://marmelab.com/blog/2016/02/29/auto-documented-makefile.html
|
|
help:
|
|
@cat Makefile | grep -v '\.PHONY' | grep -v '\help:' | grep -B1 -E '^[a-zA-Z0-9_.-]+:.*' | sed -e "s/:.*//" | sed -e "s/^## //" | grep -v '\-\-' | sed '1!G;h;$$!d' | awk 'NR%2{printf "\033[36m%-30s\033[0m",$$0;next;}1' | sort
|