studio/flamenco
studio/flamenco
11
29
Fork 38
Code Issues 66 Pull Requests 9 Releases Wiki Activity

Makefile: Add the ability to create a source code release with all deps #104240

Open
Sebastian Parborg wants to merge 4 commits from ZedDB/flamenco:vendor into main
pull from: ZedDB/flamenco:vendor
merge into: studio:main

When changing the target branch, be careful to rebase the branch in your fork to match. See documentation.
Conversation 9 Commits 4 Files Changed 3 +28 -12
3 changed files with 28 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
.gitignore vendored
View File

@ -20,6 +20,10 @@ flamenco-worker.yaml
flamenco-worker-credentials.yaml
node_modules/
# Directories used to store go and yarn dependencies for offline building
/vendor
/web/app/package-cache
# Directory for custom job compiler scripts:
/scripts/

34
Makefile
View File

@ -46,17 +46,14 @@ export CGO_ENABLED=0
all: application
# Install generators and build the software.
with-deps:
go install github.com/deepmap/oapi-codegen/cmd/oapi-codegen@v1.9.0
go install github.com/golang/mock/mockgen@v1.6.0
$(MAKE) application
vendor: webapp-deps
go mod vendor
ZedDB marked this conversation as resolved Outdated
Sybren A. Stüvel commented 2023-08-01 13:14:15 +02:00
Outdated
Review
Copy Link

Shouldn't webapp-deps be a dependency of the webapp-static rule?

Shouldn't `webapp-deps` be a dependency of the `webapp-static` rule?
Sebastian Parborg commented 2023-08-01 16:29:27 +02:00
Outdated
Review
Copy Link

That is correct.
It will not work otherwise.

I've updated the make targets to reflect this.

That is correct. It will not work otherwise. I've updated the make targets to reflect this.
vet:
go vet ./...
go run golang.org/x/vuln/cmd/govulncheck@latest ./...
application: webapp flamenco-manager flamenco-worker
application: flamenco-manager flamenco-worker
flamenco-manager:
$(MAKE) webapp-static
@ -93,10 +90,11 @@ flamenco-worker_race:
shaman-checkout-id-setter:
go build -v ${BUILD_FLAGS} ${PKG}/cmd/shaman-checkout-id-setter
webapp:
yarn --cwd web/app install
webapp-deps:
# We have to use --force here to ensure that the offline package cache is up to date with no missing files
Sybren A. Stüvel commented 2023-09-26 17:51:11 +02:00
Review
Copy Link

This comment should be hidden from the regular output. Right now it's actually shown when running make webapp-deps (and any other target that runs this target).

This comment should be hidden from the regular output. Right now it's actually shown when running `make webapp-deps` (and any other target that runs this target).
yarn --cwd web/app install --force
webapp-static: addon-packer
webapp-static: webapp-deps addon-packer
$(MAKE) clean-webapp-static
# When changing the base URL, also update the line
# e.GET("/app/*", echo.WrapHandler(webAppHandler))
@ -331,6 +329,9 @@ RELEASE_PACKAGE_WINDOWS := flamenco-${VERSION}-windows-amd64.zip
RELEASE_PACKAGE_EXTRA_FILES := README.md LICENSE CHANGELOG.md
RELEASE_PACKAGE_SHAFILE := flamenco-${VERSION}.sha256
RELEASE_SOURCE_ARCHIVE := flamenco-${VERSION}-src.tar
RELEASE_SOURCE_ARCHIVE_GZ := flamenco-${VERSION}-src.tar.gz
Sybren A. Stüvel commented 2023-09-26 17:59:11 +02:00
Review
Copy Link

I think it's better to define RELEASE_SOURCE_ARCHIVE_GZ as ${RELEASE_SOURCE_ARCHIVE}.gz

I think it's better to define `RELEASE_SOURCE_ARCHIVE_GZ` as `${RELEASE_SOURCE_ARCHIVE}.gz`
.PHONY: release-package
release-package:
$(MAKE) -s release-package-linux
@ -377,12 +378,21 @@ release-package-windows:
zip -r -9 dist/${RELEASE_PACKAGE_WINDOWS} flamenco-manager.exe flamenco-worker.exe ${RELEASE_PACKAGE_EXTRA_FILES} tools/*-windows*
@echo "Done! Created ${RELEASE_PACKAGE_WINDOWS}"
.PHONY: release-package-source
release-package-source: vendor
mkdir -p dist
rm -f dist/${RELEASE_SOURCE_ARCHIVE_GZ}
git archive --prefix=flamenco-${VERSION}/ -o dist/${RELEASE_SOURCE_ARCHIVE} HEAD
tar --transform 's,^,flamenco-${VERSION}/,' -rvf dist/${RELEASE_SOURCE_ARCHIVE} vendor web/app/package-cache
Sybren A. Stüvel commented 2023-09-26 18:00:16 +02:00
Review
Copy Link

What's the reason to use gzip separately? Why not just use tar z?

What's the reason to use `gzip` separately? Why not just use `tar z`?
gzip dist/${RELEASE_SOURCE_ARCHIVE}
@echo "Done! Created ${RELEASE_SOURCE_ARCHIVE_GZ}"
.PHONY: publish-release-packages
publish-release-packages:
$(MAKE) -s check-environment
cd dist; sha256sum ${RELEASE_PACKAGE_LINUX} ${RELEASE_PACKAGE_DARWIN} ${RELEASE_PACKAGE_WINDOWS} > ${RELEASE_PACKAGE_SHAFILE}
cd dist; sha256sum ${RELEASE_PACKAGE_LINUX} ${RELEASE_PACKAGE_DARWIN} ${RELEASE_PACKAGE_WINDOWS} ${RELEASE_SOURCE_ARCHIVE_GZ} > ${RELEASE_PACKAGE_SHAFILE}
cd dist; rsync -va \
${RELEASE_PACKAGE_LINUX} ${RELEASE_PACKAGE_DARWIN} ${RELEASE_PACKAGE_WINDOWS} ${RELEASE_PACKAGE_SHAFILE} \
${RELEASE_PACKAGE_LINUX} ${RELEASE_PACKAGE_DARWIN} ${RELEASE_PACKAGE_WINDOWS} ${RELEASE_SOURCE_ARCHIVE_GZ} ${RELEASE_PACKAGE_SHAFILE} \
${WEBSERVER_SSH}:${WEBSERVER_ROOT}/downloads/
.PHONY: application version flamenco-manager flamenco-worker flamenco-manager_race flamenco-worker_race webapp webapp-static generate generate-go generate-py with-deps swagger-ui list-embedded test clean clean-webapp-static
.PHONY: application version flamenco-manager flamenco-worker flamenco-manager_race flamenco-worker_race webapp-deps webapp-static generate generate-go generate-py vendor swagger-ui list-embedded test clean clean-webapp-static

2
web/app/.yarnrc Normal file
View File

@ -0,0 +1,2 @@
yarn-offline-mirror "./package-cache"
yarn-offline-mirror-pruning true
Sybren A. Stüvel commented 2023-09-26 17:58:08 +02:00
Review
Copy Link

Instead of always caching the packages, put this into a special file .yarnrc-source-pkg or something, and specify that when running yarn install for grabbing the sources. That way the regular builds don't have to bother with this package cache.

Instead of always caching the packages, put this into a special file `.yarnrc-source-pkg` or something, and specify that when running `yarn install` for grabbing the sources. That way the regular builds don't have to bother with this package cache.