Skip to content

Add make help #673

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

Open
hugovk wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add make help #673

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 14 additions & 0 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,10 @@ LOGLINES=50

.PHONY: venv regen-requirements

## venv Create a venv with necessary tools
venv: $(VENV_CHECK)

## clean Remove the venv
clean:
rm -rf venv

Expand All @@ -24,6 +26,7 @@ $(VENV_CHECK): $(REQUIREMENTS)
$(PIP) install -U pip
$(PIP) install -r $(REQUIREMENTS)

## regen-requirements Regenerate pinned requirements file
regen-requirements:
$(SYSTEM_PYTHON) -m venv --clear venv
$(PIP) install -U pip
Expand All @@ -34,13 +37,15 @@ regen-requirements:

.PHONY: check

## check Validate buildbot master configuration
check: $(VENV_CHECK)
$(BUILDBOT) checkconfig master

# Management targets

.PHONY: update-master start-master restart-master stop-master

## update-master Pull updates, upgrade, check config, and start master
update-master: stop-master
@if [ `git rev-parse --symbolic-full-name HEAD` = "refs/heads/main" ]; \
then \
Expand All @@ -52,12 +57,15 @@ update-master: stop-master
$(MAKE) check
$(MAKE) start-master

## start-master Start the buildbot master
start-master: TARGET=start
start-master: run-target

## restart-master Restart the buildbot master
restart-master: TARGET=restart
restart-master: run-target

## stop-master Stop the buildbot master
stop-master: TARGET=stop
stop-master: run-target
# issue #384: sometimes when "buildbot stop master" sends SIGINT to
Expand All @@ -73,9 +81,15 @@ stop-master: run-target
run-target: $(VENV_CHECK)
$(BUILDBOT) $(TARGET) master; tail -n$(LOGLINES) master/twistd.log

## git-update-requirements Create a branch with regenerated requirements
git-update-requirements:
git switch main
git pull
git switch -c reqs main
make regen-requirements
git ci -a -m "run make regen-requirements"

.PHONY: help
help : Makefile
@echo "Use \`make <target>' where <target> is one of"
@sed -n 's/^##//p' $<