Browse Source

Add 'watch-backend' (#12330)

* Add 'watch-backend'

This leverages `air` to watch the backend files and trigger `make
backend` automatically when they change. It seems to work rather well
together with `watch-frontend`.


* rework docs to a new section for continuous build

Co-authored-by: techknowlogick <>
silverwind 9 months ago
committed by GitHub
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 39 additions and 17 deletions
  1. +9
  2. +1
  3. +11
  4. +18

+ 9
- 0
.air.conf View File

@@ -0,0 +1,9 @@
root = "."
tmp_dir = ".air"

cmd = "make backend"
bin = "gitea"
include_ext = ["go", "tmpl"]
exclude_dir = ["modules/git/tests", "services/gitdiff/testdata", "modules/avatar/testdata"]
include_dir = ["cmd", "models", "modules", "options", "routers", "services", "templates"]

+ 1
- 0
.gitignore View File

@@ -81,6 +81,7 @@ coverage.all

# Snapcraft

+ 11
- 1
Makefile View File

@@ -106,6 +106,8 @@ BINDATA_HASH := $(addsuffix .hash,$(BINDATA_DEST))

SVG_DEST_DIR := public/img/svg

AIR_TMP_DIR := .air

TAGS_SPLIT := $(subst $(COMMA), ,$(TAGS))
@@ -161,6 +163,7 @@ help:
@echo " - lint-frontend lint frontend files"
@echo " - lint-backend lint backend files"
@echo " - watch-frontend watch frontend files and continuously rebuild"
@echo " - watch-backend watch backend files and continuously rebuild"
@echo " - webpack build webpack files"
@echo " - svg build svg files"
@echo " - fomantic build fomantic files"
@@ -306,6 +309,13 @@ watch-frontend: node-check $(FOMANTIC_DEST) node_modules
NODE_ENV=development npx webpack --hide-modules --display-entrypoints=false --watch --progress

.PHONY: watch-backend
watch-backend: go-check
@hash air > /dev/null 2>&1; if [ $$? -ne 0 ]; then \
GO111MODULE=off $(GO) get -u; \
air -c .air.conf

.PHONY: test
$(GO) test $(GOTESTFLAGS) -mod=vendor -tags='sqlite sqlite_unlock_notify' $(GO_PACKAGES)
@@ -579,7 +589,7 @@ release-compress: | $(DIST_DIRS)
.PHONY: release-sources
release-sources: | $(DIST_DIRS) node_modules
tar --exclude=./$(DIST) --exclude=./.git --exclude=./$(MAKE_EVIDENCE_DIR) --exclude=./node_modules/.cache -czf $(DIST)/release/gitea-src-$(VERSION).tar.gz .
tar --exclude=./$(DIST) --exclude=./.git --exclude=./$(MAKE_EVIDENCE_DIR) --exclude=./node_modules/.cache --exclude=./$(AIR_TMP_DIR) -czf $(DIST)/release/gitea-src-$(VERSION).tar.gz .

.PHONY: release-docs

+ 18
- 16
docs/content/doc/advanced/ View File

@@ -91,7 +91,23 @@ The simplest recommended way to build from source is:
TAGS="bindata sqlite sqlite_unlock_notify" make build

See `make help` for all available `make` tasks. Also see [`.drone.yml`]( to see how our continuous integration works.
The `build` target will execute both `frontend` and `backend` sub-targets. If the `bindata` tag is present, the frontend files will be compiled into the binary. It is recommended to leave out the tag when doing frontend development so that changes will be reflected.

See `make help` for all available `make` targets. Also see [`.drone.yml`]( to see how our continuous integration works.

## Building continuously

Both the `frontend` and `backend` targets can be ran continuously when source files change:

# in your first terminal
make watch-backend

# in your second terminal
make watch-frontend

On macOS, watching all backend source files may hit the default open files limit which can be increased via `ulimit -n 12288` for the current shell or in your shell startup file for all future shells.

### Formatting, code analysis and spell check

@@ -123,26 +139,12 @@ make revive vet misspell-check

### Working on JS and CSS

For simple changes, edit files in `web_src`, run the build and start the server to test:
Either use the `watch-frontend` target mentioned above or just build once:

make build && ./gitea

`make build` runs both `make frontend` and `make backend` which can be run individually as well as long as the `bindata` tag is not used (which compiles frontend files into the binary).

For more involved changes use the `watch-frontend` task to continuously rebuild files when their sources change. The `bindata` tag must be absent. First, build and run the backend:

make backend && ./gitea

With the backend running, open another terminal and run:

make watch-frontend

Before committing, make sure the linters pass: