enso-org/enso
1
1
Fork 0
mirror of https://github.com/enso-org/enso.git synced 2024-11-26 08:52:58 +03:00
Code Issues Projects Releases Wiki Activity
f82e8020fe
enso/build
History
Michał Wawrzyniec Urbańczyk d9ca6cf023
Build Script Post-Gui1 Cleanup (#9376) 
This PR:
* removes much of logic related to building and packaging the gui1;
* made `./run gui` and `./run ide` work with the new gui;
* rename numerous references to the "gui2" or "new gui" in favor of simply "gui", same for "ide".
2024-03-12 20:25:51 +01:00
..
base Force newDashboard default on the CI-built packages. (#6680) 2023-05-15 04:03:09 +02:00
build Build Script Post-Gui1 Cleanup (#9376) 2024-03-12 20:25:51 +01:00
ci_utils Add some engine jobs that run with Oracle GraalVM (#9322) 2024-03-12 20:25:26 +01:00
ci-gen Remove gui1 codebase (#9242) 2024-03-07 02:20:21 +00:00
cli Build Script Post-Gui1 Cleanup (#9376) 2024-03-12 20:25:51 +01:00
deprecated/rust-scripts Removed enso-types and a some unused dependencies. (#9342) 2024-03-11 17:44:39 +00:00
enso-formatter New node design (#7311) 2023-07-27 13:00:47 +00:00
intellij-run-config-gen Eager shader compilation (#5606) 2023-02-22 00:29:48 +01:00
macros Introduce new focus APIs, and use for CB (#7167) 2023-07-26 22:13:48 +00:00
.gitignore Build script merge (#3743) 2022-10-10 23:38:48 +02:00
README.md Build Script Post-Gui1 Cleanup (#9376) 2024-03-12 20:25:51 +01:00

README.md


Enso Language

[WIP] Enso CI Build Scripts

The code under this directory is under ongoing intensive development. As such it has not been reviewed or cleaned up yet.

General principles

  • Written in Rust.
  • Portable. Works on any platform that Enso targets.
  • Do not duplicate functionality that is already available in tools being part of our tech stack.
  • Supports both developers and CI use-cases (and environments). Developers can call it locally to do anything that CI does.
  • Does not require much setup work. Where feasible sets things up for the user.

Concepts

Target

  • Can be built locally from sources. Building yields artifacts.
  • Artifacts are self-contained to a single filesystem directory.
  • Artifacts can be downloaded from a remote location rather than built with the same effect.
  • Can contain other targets.
  • Artifacts can be platform-specific.
  • Artifacts must be releasable as CI run artifacts or release assets.

Usage

While the script is invoked using cargo run, the convenience run script is provided in the repository root.

The general usage form is:

./run <command> [options]

The command itself is usually a combination of target name and subcommand, like ide build or backend test.

At every layer, the --help command can be used to get more information. Note that the information depends on the command, so running ./run --help will not give you the same information as ./run ide --help nor ./run ide build --help.

Targets

IDE

IDE is the top level target for our project. It consists of GUI and Backend targets.

Sources consist mostly of TS code for the Electron client and packaging.

Artifacts are platform specific and consist of the single image file.

GUI

GUI is the front-end part of the project. It also packages WASM-compiled parser written in rust.

Artifacts are portable across the platforms and consist of the web page that can be served either using Electron client (as IDE does) or using a web server (like the Cloud version of Enso).

Backend

Backend is the back-end part of the project, as seen from the IDE perspective. It contains a Project Manager bundle that includes:

  • Project Manager native image;
  • Enso Engine distribution (with the Standard Library);
  • GraalVM distribution.

These components are not represented as "Targets" (in terms of build script) but could be and likely will be in the future.