Makefile & BSDmakefile changes #7455

Matlib · 2025-04-03T22:40:41+02:00

Matlib commented

2025-04-03 22:40:41 +02:00

This set of commits fixes multiple issues with both make scripts. It started with #7358 and digging into it I found more problems.

@Gusted commented:

I do think the place where verify-version gets called should likely be backend instead and the error should likely include extra details on how to fix the error, but that can be discussed in the PR.

I think it should be closest to where $(FORGEJO_VERSION) is used and that's part of $(LDFLAGS), so I added it where the latter is used.

When it comes to wording feel free to make suggestions.

I haven't tested docker builds.

I believe the most optimal way to do it is to create POSIX-compliant shell script where all those conditionals and variable expansion may be placed, and then that script should generate POSIX-compliant Makefile.

Testing

BSDMakefile

Should be launched from a BSD OS. You need to add -f BSDMakefile on OpenBSD.

make show-version-major show-version-minor
Should display two lines with version numbers.
make TAGS=bindata
Should launch the building process once.

Makefile

make TAGS=bindata
Should do the same as make build.
make target
Should build given target like it used to.
Copy everything except .git and VERSION to a separate directory.
make TAGS=bindata
Should fail with error “Could not determine FORGEJO_VERSION...”
Copy everything except .git and VERSION to a separate directory.
make clean
Should execute correctly.

This set of commits fixes multiple issues with both make scripts. It started with #7358 and digging into it I found more problems. @Gusted [commented](https://codeberg.org/forgejo/forgejo/issues/7358#issuecomment-3145145): > I do think the place where verify-version gets called should likely be backend instead and the error should likely include extra details on how to fix the error, but that can be discussed in the PR. I think it should be closest to where `$(FORGEJO_VERSION)` is used and that's part of `$(LDFLAGS)`, so I added it where the latter is used. When it comes to wording feel free to make suggestions. **I haven't tested docker builds.** I believe the most optimal way to do it is to create POSIX-compliant shell script where all those conditionals and variable expansion may be placed, and then that script should generate POSIX-compliant Makefile. # Testing ## BSDMakefile Should be launched from a BSD OS. You need to add `-f BSDMakefile` on OpenBSD. * `make show-version-major show-version-minor` Should display two lines with version numbers. * `make TAGS=bindata` Should launch the building process once. ## Makefile * `make TAGS=bindata` Should do the same as `make build`. * `make `*target* Should build given target like it used to. * Copy everything except *.git* and *VERSION* to a separate directory. `make TAGS=bindata` Should fail with error “Could not determine FORGEJO_VERSION...” * Copy everything except *.git* and *VERSION* to a separate directory. `make clean` Should execute correctly.

Matlib added the

test

needed

label

2025-04-03 22:40:41 +02:00

earl-warren added

and removed

labels

2025-04-04 05:33:13 +02:00

earl-warren changed title from ~~WIP: Makefile & BSDmakefile changes~~ to WIP: Makefile & BSDmakefile changes [skip ci]

2025-04-04 05:33:39 +02:00

earl-warren commented

2025-04-04 05:35:40 +02:00

I find this a good safeguard. Regarding testing, instructions like this added to the description of the PR will be good enough:

Testing

step 1
step 2
etc.

I find this a good safeguard. Regarding testing, instructions like this added to the description of the PR will be good enough: ## Testing - step 1 - step 2 - etc.

Gusted reviewed

2025-04-04 14:50:17 +02:00

Gusted left a comment

Otherwise LGTM, many thanks!

Makefile Outdated

					
				@ -845,3 +861,3 @@

					@echo "NOT NEEDED: THIS IS A NOOP AS OF Forgejo 7.0 BUT KEPT FOR BACKWARD COMPATIBILITY"

				$(EXECUTABLE): $(GO_SOURCES) $(TAGS_PREREQ)

				$(EXECUTABLE): $(GO_SOURCES) $(TAGS_PREREQ) | verify-version

Why an order-only-prerequisite?

verify-version is never satisfied (these is no file by that name, and in fact it is a .PHONY target) thus it would force compilation every time.

Try this simple Makefile:

.PHONY: verify-version
verify-version:
	@echo 'Version Verified!'
all: | verify-version
	@echo Gotta create all
	@touch all

The output is:

$ rm -f all
$ make all
Version Verified!
Gotta create all
$ make all
Version Verified!
$
...

If you remove |, then all is executed every time:

$ rm -f all
$ make all
Version Verified!
Gotta create all
$ make all
Version Verified!
Gotta create all
$
...

`verify-version` is never satisfied (these is no file by that name, and in fact it is a .PHONY target) thus it would force compilation every time. Try this simple Makefile: ```makefile .PHONY: verify-version verify-version: @echo 'Version Verified!' all: | verify-version @echo Gotta create all @touch all ``` The output is: ``` $ rm -f all $ make all Version Verified! Gotta create all $ make all Version Verified! $ ... ``` If you remove |, then *all* is executed every time: ``` $ rm -f all $ make all Version Verified! Gotta create all $ make all Version Verified! Gotta create all $ ... ```

Ah that's interesting, thank you!

Gusted marked this conversation as resolved

Matlib commented

2025-04-08 01:22:14 +02:00

FreeBSD two targets

matlib@m-002:~/src/forgejo-git$ make show-version-major show-version-minor
12
12.0

FreeBSD no explicit target

matlib@m-002:~/src/forgejo-git$ make TAGS=bindata
Running go generate...
bindata for migration already up-to-date
bindata for options already up-to-date
bindata for public already up-to-date
bindata for templates already up-to-date

FreeBSD no VERSION

matlib@m-002:~/src/forgejo-test$ rm -rf VERSION gitea .git matlib@m-002:~/src/forgejo-test$ make clean rm -rf gitea dist modules/public/bindata.go modules/options/bindata.go modules/templates/bindata.go modules/public/bindata.go.hash modules/options/bindata.go.hash modules/templates/bindata.go.hash \ integrations*.test \ e2e*.test \ tests/integration/gitea-integration-* \ tests/integration/indexers-* \ tests/mysql.ini tests/pgsql.ini man/ \ tests/e2e/gitea-e2e-*/ \ tests/e2e/indexers-*/ \ tests/e2e/reports/ tests/e2e/test-artifacts/ tests/e2e/test-snapshots/ matlib@m-002:~/src/forgejo-test$ make Running go generate... Error: Could not determine FORGEJO_VERSION; version file VERSION not present and no suitable git tag found gmake[1]: *** [Makefile:276: verify-version] Error 1 *** Error code 2

Stop.
make: stopped in /usr/home/matlib/src/forgejo-test

OpenBSD two targets

matlib@m-006:~/src/forgejo-git$ make -f BSDmakefile show-version-major show-version-minor
12
12.0

OpenBSD no VERSION

matlib@m-006:~/src/forgejo-test$ make -f BSDmakefile clean
rm -rf gitea dist modules/public/bindata.go modules/options/bindata.go modules/templates/bindata.go modules/public/bindata.go.hash modules/options/bindata.go.hash modules/templates/bindata.go.hash \
    integrations*.test \
    e2e*.test \
    tests/integration/gitea-integration-* \
    tests/integration/indexers-* \
    tests/mysql.ini tests/pgsql.ini man/ \
    tests/e2e/gitea-e2e-*/ \
    tests/e2e/indexers-*/ \
    tests/e2e/reports/ tests/e2e/test-artifacts/ tests/e2e/test-snapshots/
matlib@m-006:~/src/forgejo-test$ make -f BSDmakefile backend
Running go generate...
Error: Could not determine FORGEJO_VERSION; version file VERSION not present and no suitable git tag found
gmake: *** [Makefile:276: verify-version] Error 1
*** Error 2 in /home/matlib/src/forgejo-test (BSDmakefile:55 'backend': "gmake"  "--no-print-directory"  backend)

<details> <summary>FreeBSD two targets</summary> <pre> matlib@m-002:~/src/forgejo-git$ make show-version-major show-version-minor 12 12.0 </pre> </details> <details> <summary>FreeBSD no explicit target</summary> <pre> matlib@m-002:~/src/forgejo-git$ make TAGS=bindata Running go generate... bindata for migration already up-to-date bindata for options already up-to-date bindata for public already up-to-date bindata for templates already up-to-date </pre> </details> <details> <summary>FreeBSD no VERSION</summary> <pre> matlib@m-002:~/src/forgejo-test$ rm -rf VERSION gitea .git matlib@m-002:~/src/forgejo-test$ make clean rm -rf gitea dist modules/public/bindata.go modules/options/bindata.go modules/templates/bindata.go modules/public/bindata.go.hash modules/options/bindata.go.hash modules/templates/bindata.go.hash \ integrations*.test \ e2e*.test \ tests/integration/gitea-integration-* \ tests/integration/indexers-* \ tests/mysql.ini tests/pgsql.ini man/ \ tests/e2e/gitea-e2e-*/ \ tests/e2e/indexers-*/ \ tests/e2e/reports/ tests/e2e/test-artifacts/ tests/e2e/test-snapshots/ matlib@m-002:~/src/forgejo-test$ make Running go generate... Error: Could not determine FORGEJO_VERSION; version file VERSION not present and no suitable git tag found gmake[1]: *** [Makefile:276: verify-version] Error 1 *** Error code 2 Stop. make: stopped in /usr/home/matlib/src/forgejo-test </pre> </details> <details> <summary>OpenBSD two targets</summary> <pre> matlib@m-006:~/src/forgejo-git$ make -f BSDmakefile show-version-major show-version-minor 12 12.0 </pre> </details> <details> <summary>OpenBSD no VERSION</summary> <pre> matlib@m-006:~/src/forgejo-test$ make -f BSDmakefile clean rm -rf gitea dist modules/public/bindata.go modules/options/bindata.go modules/templates/bindata.go modules/public/bindata.go.hash modules/options/bindata.go.hash modules/templates/bindata.go.hash \ integrations*.test \ e2e*.test \ tests/integration/gitea-integration-* \ tests/integration/indexers-* \ tests/mysql.ini tests/pgsql.ini man/ \ tests/e2e/gitea-e2e-*/ \ tests/e2e/indexers-*/ \ tests/e2e/reports/ tests/e2e/test-artifacts/ tests/e2e/test-snapshots/ matlib@m-006:~/src/forgejo-test$ make -f BSDmakefile backend Running go generate... Error: Could not determine FORGEJO_VERSION; version file VERSION not present and no suitable git tag found gmake: *** [Makefile:276: verify-version] Error 1 *** Error 2 in /home/matlib/src/forgejo-test (BSDmakefile:55 'backend': "gmake" "--no-print-directory" backend) </pre> </details>

Matlib changed title from ~~WIP: Makefile & BSDmakefile changes [skip ci]~~ to Makefile & BSDmakefile changes [skip ci]

2025-04-08 01:22:47 +02:00

Gusted reviewed

2025-04-08 07:43:48 +02:00

Makefile Outdated

					
				@ -279,0 +273,4 @@

				verify-version:

				ifeq ($(FORGEJO_VERSION),)

					@echo "Error: Could not determine FORGEJO_VERSION; version file $(STORED_VERSION_FILE) not present and no suitable git tag found"

					@false

Alright lets try to add a extra echo here with details how it can be fixed.

@echo "In most cases this likely means you forgot to fetch git tags, you can fix this by executing `git fetch --tags`. If this is not possible and this is part of a custom build process, then you can set a specific version by writing it to $(STORED_VERSION_FILE) (This must be a semver compatible version)"

Alright lets try to add a extra echo here with details how it can be fixed. ```sh @echo "In most cases this likely means you forgot to fetch git tags, you can fix this by executing `git fetch --tags`. If this is not possible and this is part of a custom build process, then you can set a specific version by writing it to $(STORED_VERSION_FILE) (This must be a semver compatible version)" ```

matlib@m-002:~/src/forgejo-test$ make
Running go generate...
Error: Could not determine FORGEJO_VERSION; version file VERSION not present and no suitable git tag found
In most cases this likely means you forgot to fetch git tags, you can fix this by executing `git fetch --tags`. If this is not possible and this is part of a custom build process, then you can set a specific version by writing it to VERSION (This must be a semver compatible version).
gmake[1]: *** [Makefile:277: verify-version] Error 1
*** Error code 2

Stop.
make: stopped in /usr/home/matlib/src/forgejo-test

``` matlib@m-002:~/src/forgejo-test$ make Running go generate... Error: Could not determine FORGEJO_VERSION; version file VERSION not present and no suitable git tag found In most cases this likely means you forgot to fetch git tags, you can fix this by executing `git fetch --tags`. If this is not possible and this is part of a custom build process, then you can set a specific version by writing it to VERSION (This must be a semver compatible version). gmake[1]: *** [Makefile:277: verify-version] Error 1 *** Error code 2 Stop. make: stopped in /usr/home/matlib/src/forgejo-test ```

👍 1

Gusted marked this conversation as resolved

Gusted approved these changes

2025-04-09 21:35:22 +02:00

Gusted left a comment

Thank you.

Gusted requested review from earl-warren

2025-04-09 21:35:52 +02:00

earl-warren changed title from ~~Makefile & BSDmakefile changes [skip ci]~~ to Makefile & BSDmakefile changes

2025-04-27 12:02:51 +02:00

earl-warren force-pushed #7358 from 01b18ce055

issue-labels / release-notes (pull_request_target) Has been skipped