-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
BUG: Subproject reviewed rather than main project
A review/audit always had too much of the subproject changes within them. This makes it difficult for the user as well as for GPT to attend to the main project changes. Especially when those subprojects actually are submodules that should have their own review process. We want to focus on the main project changes: It is enough that subprojects PASS. Also rename makemake.py build.py since we use it to make files in build/. We may want to make it in there instead of next to the Makefile. * Document downloading and using the generic Makefile. * Use -m build instead of makemake.py. * Do not analyze (now) build.py outside its normalize origin. * Remove subproject reports and diffs.
- Loading branch information
Joppe
committed
Mar 25, 2024
1 parent
62f9e0b
commit 1ba0d91
Showing
5 changed files
with
128 additions
and
111 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,55 +1,46 @@ | ||
## Tool for generating build dependencies: makemake.py | ||
## Tool for using and reporting arbitrary nested projects | ||
|
||
--- | ||
|
||
``` | ||
$ python3 makemake.py --makemake --generic > Makefile && make | ||
$ GH="https://raw.githubusercontent.com"; curl $GH/joakimbits/normalize/main/template/Makefile -o Makefile && make | ||
``` | ||
|
||
- Compiles local sources and installs a local venv ready to run all local python modules. | ||
- Create executables from all source files. | ||
- Recursively also in sub-directories with a README.md file, or any other .md file. | ||
|
||
``` | ||
$ make pdf html slides | ||
``` | ||
|
||
- Tests the python and command line usage examples, and generates project reports. | ||
- Tests all usage examples, and generates project reports if they all PASS. | ||
|
||
--- | ||
|
||
- The generic Makefile builds exactly the same when included in a parent Makefile anywhere. | ||
- It also isolates its own dependencies into a local python venv. | ||
|
||
```sh | ||
$ python3 makemake.py --makemake --generic | ||
# normalize$ makemake.py --makemake --generic | ||
_Makefile := $(lastword $(MAKEFILE_LIST)) | ||
/ := $(patsubst %build/,%,$(patsubst ./%,%,$(patsubst C:/%,/c/%,$(subst \,/,$(dir $(Makefile)))))) | ||
$/bringup: | ||
$/build/project.mk: | ||
mkdir -p $(dir $@) && curl https://raw.githubusercontent.com/joakimbits/normalize/main/Makefile -o $@ | ||
-include $/build/project.mk | ||
|
||
``` | ||
$ make old new review audit | ||
``` | ||
|
||
--- | ||
|
||
There is a simpler variant: | ||
|
||
- It can only be included from within the same directory, without a venv. | ||
- Analyze changes and use GPT to generate release notes. | ||
|
||
--- | ||
|
||
Standalone variant: | ||
|
||
```sh | ||
$ python3 makemake.py --makemake | ||
all: build/makemake.py.tested | ||
build/makemake.py.tested: makemake.py build/makemake.py.bringup | ||
makemake.py --test > $@ | ||
build/makemake.py.bringup: makemake.py | $(PYTHON) | ||
$ build.py --makemake | ||
bringup: build/build.py.bringup | ||
tested: build/build.py.tested | ||
build/build.py.tested: build.py build/build.py.shebang build/build.py.mk | ||
build.py --test > $@ | ||
build/build.py.shebang: build.py build/build.py.bringup | ||
$(PYTHON) build.py --shebang > $@ | ||
build/build.py.bringup: build.py | $(PYTHON) | ||
mkdir -p build/ && \ | ||
$(PYTHON) -m pip install requests tiktoken --no-warn-script-location > $@ | ||
|
||
``` | ||
|
||
- Python version 3.7 or later is required. | ||
- Python version 3.8 or later is required. | ||
|
||
[example/README.md](example/README.md) |
Oops, something went wrong.