5f37bcb629
Convert most of the code in `Makefile` to [Magefile](https://magefile.org/): This makes it possible to build Flamenco without `make` (and the POSIX environment/commands it expect) by running: ```bash $ go run mage.go webappInstallDeps # Only on the first build. $ go run mage.go build ``` More efficient builds are possible with other commands, and some release-related commands still require `make`. At least the barrier to entry should be considerably lower (compared to having to install Make + Cygwin/MSYS2 on Windows). Fix: #102633 This does not port the building of release packages, so it doesn't address #102671. ### Main Targets | Target | Description | |----------|---------------------------------------------------------------------------------| | build | Build Flamenco Manager and Flamenco Worker, including the webapp and the add-on | | check | Run unit tests, check for vulnerabilities, and run the linter | | clean | Remove executables and other build output | | generate | Generate code (OpenAPI and test mocks) | ### All Targets Get these via `go run mage.go -l`: ``` Targets: build Flamenco Manager and Flamenco Worker, including the webapp and the add-on check Run unit tests, check for vulnerabilities, and run the linter clean Remove executables and other build output flamencoManager Build Flamenco Manager with the webapp and add-on ZIP embedded flamencoManagerWithoutWebapp Only build the Flamenco Manager executable, do not rebuild the webapp flamencoWorker Build the Flamenco Worker executable generate code (OpenAPI and test mocks) generateGo Generate Go code for Flamenco Manager and Worker generateJS Generate JavaScript code for the webapp generatePy Generate Python code for the add-on govulncheck Check for known vulnerabilities. staticcheck Analyse the source code. test Run unit tests version Show which version information would be embedded in executables vet Run `go vet` webappInstallDeps Use Yarn to install the webapp's NodeJS dependencies webappStatic Build the webapp as static files that can be served ``` Co-authored-by: Mateus Abelli <mateusabelli@gmail.com> Reviewed-on: https://projects.blender.org/studio/flamenco/pulls/104341
65 lines
1.5 KiB
Go
65 lines
1.5 KiB
Go
//go:build mage
|
|
|
|
package main
|
|
|
|
import (
|
|
"fmt"
|
|
"os"
|
|
"path/filepath"
|
|
|
|
"github.com/magefile/mage/sh"
|
|
)
|
|
|
|
// Remove executables and other build output
|
|
func Clean() error {
|
|
if err := cleanWebappStatic(); err != nil {
|
|
return err
|
|
}
|
|
|
|
if err := sh.Run("go", "clean"); err != nil {
|
|
return err
|
|
}
|
|
|
|
if err := rm(
|
|
"flamenco-manager", "flamenco-manager.exe",
|
|
"flamenco-manager_race", "flamenco-manager_race.exe",
|
|
"flamenco-worker", "flamenco-worker.exe",
|
|
"flamenco-worker_race", "flamenco-worker_race.exe",
|
|
); err != nil {
|
|
return err
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func cleanWebappStatic() error {
|
|
// Just a simple heuristic to avoid deleting things like "/" or "C:\"
|
|
if len(webStatic) < 4 {
|
|
panic(fmt.Sprintf("webStatic path is too short, I don't trust it: %q", webStatic))
|
|
}
|
|
|
|
if err := sh.Rm(webStatic); err != nil {
|
|
return fmt.Errorf("unable to remove old web static dir %q: %w", webStatic, err)
|
|
}
|
|
if err := os.MkdirAll(webStatic, os.ModePerm); err != nil {
|
|
return fmt.Errorf("unable to create web static dir %q: %w", webStatic, err)
|
|
}
|
|
|
|
// Make sure there is at least something to embed by Go, or it may cause some
|
|
// errors. This is done in the 'clean' function so that the Go code can be
|
|
// built before building the webapp.
|
|
emptyfile := filepath.Join(webStatic, "emptyfile")
|
|
if err := os.WriteFile(emptyfile, []byte{}, os.ModePerm); err != nil {
|
|
return err
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func rm(path ...string) error {
|
|
for _, p := range path {
|
|
if err := sh.Rm(p); err != nil {
|
|
return err
|
|
}
|
|
}
|
|
return nil
|
|
}
|