diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100644 index 00000000..3c59af53 --- /dev/null +++ b/.github/workflows/release.yml @@ -0,0 +1,296 @@ +# This file was autogenerated by dist: https://axodotdev.github.io/cargo-dist +# +# Copyright 2022-2024, axodotdev +# SPDX-License-Identifier: MIT or Apache-2.0 +# +# CI that: +# +# * checks for a Git Tag that looks like a release +# * builds artifacts with dist (archives, installers, hashes) +# * uploads those artifacts to temporary workflow zip +# * on success, uploads the artifacts to a GitHub Release +# +# Note that the GitHub Release will be created with a generated +# title/body based on your changelogs. + +name: Release +permissions: + "contents": "write" + +# This task will run whenever you push a git tag that looks like a version +# like "1.0.0", "v0.1.0-prerelease.1", "my-app/0.1.0", "releases/v1.0.0", etc. +# Various formats will be parsed into a VERSION and an optional PACKAGE_NAME, where +# PACKAGE_NAME must be the name of a Cargo package in your workspace, and VERSION +# must be a Cargo-style SemVer Version (must have at least major.minor.patch). +# +# If PACKAGE_NAME is specified, then the announcement will be for that +# package (erroring out if it doesn't have the given version or isn't dist-able). +# +# If PACKAGE_NAME isn't specified, then the announcement will be for all +# (dist-able) packages in the workspace with that version (this mode is +# intended for workspaces with only one dist-able package, or with all dist-able +# packages versioned/released in lockstep). +# +# If you push multiple tags at once, separate instances of this workflow will +# spin up, creating an independent announcement for each one. However, GitHub +# will hard limit this to 3 tags per commit, as it will assume more tags is a +# mistake. +# +# If there's a prerelease-style suffix to the version, then the release(s) +# will be marked as a prerelease. +on: + pull_request: + push: + tags: + - '**[0-9]+.[0-9]+.[0-9]+*' + +jobs: + # Run 'dist plan' (or host) to determine what tasks we need to do + plan: + runs-on: "ubuntu-22.04" + outputs: + val: ${{ steps.plan.outputs.manifest }} + tag: ${{ !github.event.pull_request && github.ref_name || '' }} + tag-flag: ${{ !github.event.pull_request && format('--tag={0}', github.ref_name) || '' }} + publishing: ${{ !github.event.pull_request }} + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + steps: + - uses: actions/checkout@v4 + with: + persist-credentials: false + submodules: recursive + - name: Install dist + # we specify bash to get pipefail; it guards against the `curl` command + # failing. otherwise `sh` won't catch that `curl` returned non-0 + shell: bash + run: "curl --proto '=https' --tlsv1.2 -LsSf https://github.com/axodotdev/cargo-dist/releases/download/v0.30.3/cargo-dist-installer.sh | sh" + - name: Cache dist + uses: actions/upload-artifact@v4 + with: + name: cargo-dist-cache + path: ~/.cargo/bin/dist + # sure would be cool if github gave us proper conditionals... + # so here's a doubly-nested ternary-via-truthiness to try to provide the best possible + # functionality based on whether this is a pull_request, and whether it's from a fork. + # (PRs run on the *source* but secrets are usually on the *target* -- that's *good* + # but also really annoying to build CI around when it needs secrets to work right.) + - id: plan + run: | + dist ${{ (!github.event.pull_request && format('host --steps=create --tag={0}', github.ref_name)) || 'plan' }} --output-format=json > plan-dist-manifest.json + echo "dist ran successfully" + cat plan-dist-manifest.json + echo "manifest=$(jq -c "." plan-dist-manifest.json)" >> "$GITHUB_OUTPUT" + - name: "Upload dist-manifest.json" + uses: actions/upload-artifact@v4 + with: + name: artifacts-plan-dist-manifest + path: plan-dist-manifest.json + + # Build and packages all the platform-specific things + build-local-artifacts: + name: build-local-artifacts (${{ join(matrix.targets, ', ') }}) + # Let the initial task tell us to not run (currently very blunt) + needs: + - plan + if: ${{ fromJson(needs.plan.outputs.val).ci.github.artifacts_matrix.include != null && (needs.plan.outputs.publishing == 'true' || fromJson(needs.plan.outputs.val).ci.github.pr_run_mode == 'upload') }} + strategy: + fail-fast: false + # Target platforms/runners are computed by dist in create-release. + # Each member of the matrix has the following arguments: + # + # - runner: the github runner + # - dist-args: cli flags to pass to dist + # - install-dist: expression to run to install dist on the runner + # + # Typically there will be: + # - 1 "global" task that builds universal installers + # - N "local" tasks that build each platform's binaries and platform-specific installers + matrix: ${{ fromJson(needs.plan.outputs.val).ci.github.artifacts_matrix }} + runs-on: ${{ matrix.runner }} + container: ${{ matrix.container && matrix.container.image || null }} + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + BUILD_MANIFEST_NAME: target/distrib/${{ join(matrix.targets, '-') }}-dist-manifest.json + steps: + - name: enable windows longpaths + run: | + git config --global core.longpaths true + - uses: actions/checkout@v4 + with: + persist-credentials: false + submodules: recursive + - name: Install Rust non-interactively if not already installed + if: ${{ matrix.container }} + run: | + if ! command -v cargo > /dev/null 2>&1; then + curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y + echo "$HOME/.cargo/bin" >> $GITHUB_PATH + fi + - name: Install dist + run: ${{ matrix.install_dist.run }} + # Get the dist-manifest + - name: Fetch local artifacts + uses: actions/download-artifact@v4 + with: + pattern: artifacts-* + path: target/distrib/ + merge-multiple: true + - name: Install dependencies + run: | + ${{ matrix.packages_install }} + - name: Build artifacts + run: | + # Actually do builds and make zips and whatnot + dist build ${{ needs.plan.outputs.tag-flag }} --print=linkage --output-format=json ${{ matrix.dist_args }} > dist-manifest.json + echo "dist ran successfully" + - id: cargo-dist + name: Post-build + # We force bash here just because github makes it really hard to get values up + # to "real" actions without writing to env-vars, and writing to env-vars has + # inconsistent syntax between shell and powershell. + shell: bash + run: | + # Parse out what we just built and upload it to scratch storage + echo "paths<> "$GITHUB_OUTPUT" + dist print-upload-files-from-manifest --manifest dist-manifest.json >> "$GITHUB_OUTPUT" + echo "EOF" >> "$GITHUB_OUTPUT" + + cp dist-manifest.json "$BUILD_MANIFEST_NAME" + - name: "Upload artifacts" + uses: actions/upload-artifact@v4 + with: + name: artifacts-build-local-${{ join(matrix.targets, '_') }} + path: | + ${{ steps.cargo-dist.outputs.paths }} + ${{ env.BUILD_MANIFEST_NAME }} + + # Build and package all the platform-agnostic(ish) things + build-global-artifacts: + needs: + - plan + - build-local-artifacts + runs-on: "ubuntu-22.04" + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + BUILD_MANIFEST_NAME: target/distrib/global-dist-manifest.json + steps: + - uses: actions/checkout@v4 + with: + persist-credentials: false + submodules: recursive + - name: Install cached dist + uses: actions/download-artifact@v4 + with: + name: cargo-dist-cache + path: ~/.cargo/bin/ + - run: chmod +x ~/.cargo/bin/dist + # Get all the local artifacts for the global tasks to use (for e.g. checksums) + - name: Fetch local artifacts + uses: actions/download-artifact@v4 + with: + pattern: artifacts-* + path: target/distrib/ + merge-multiple: true + - id: cargo-dist + shell: bash + run: | + dist build ${{ needs.plan.outputs.tag-flag }} --output-format=json "--artifacts=global" > dist-manifest.json + echo "dist ran successfully" + + # Parse out what we just built and upload it to scratch storage + echo "paths<> "$GITHUB_OUTPUT" + jq --raw-output ".upload_files[]" dist-manifest.json >> "$GITHUB_OUTPUT" + echo "EOF" >> "$GITHUB_OUTPUT" + + cp dist-manifest.json "$BUILD_MANIFEST_NAME" + - name: "Upload artifacts" + uses: actions/upload-artifact@v4 + with: + name: artifacts-build-global + path: | + ${{ steps.cargo-dist.outputs.paths }} + ${{ env.BUILD_MANIFEST_NAME }} + # Determines if we should publish/announce + host: + needs: + - plan + - build-local-artifacts + - build-global-artifacts + # Only run if we're "publishing", and only if plan, local and global didn't fail (skipped is fine) + if: ${{ always() && needs.plan.result == 'success' && needs.plan.outputs.publishing == 'true' && (needs.build-global-artifacts.result == 'skipped' || needs.build-global-artifacts.result == 'success') && (needs.build-local-artifacts.result == 'skipped' || needs.build-local-artifacts.result == 'success') }} + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + runs-on: "ubuntu-22.04" + outputs: + val: ${{ steps.host.outputs.manifest }} + steps: + - uses: actions/checkout@v4 + with: + persist-credentials: false + submodules: recursive + - name: Install cached dist + uses: actions/download-artifact@v4 + with: + name: cargo-dist-cache + path: ~/.cargo/bin/ + - run: chmod +x ~/.cargo/bin/dist + # Fetch artifacts from scratch-storage + - name: Fetch artifacts + uses: actions/download-artifact@v4 + with: + pattern: artifacts-* + path: target/distrib/ + merge-multiple: true + - id: host + shell: bash + run: | + dist host ${{ needs.plan.outputs.tag-flag }} --steps=upload --steps=release --output-format=json > dist-manifest.json + echo "artifacts uploaded and released successfully" + cat dist-manifest.json + echo "manifest=$(jq -c "." dist-manifest.json)" >> "$GITHUB_OUTPUT" + - name: "Upload dist-manifest.json" + uses: actions/upload-artifact@v4 + with: + # Overwrite the previous copy + name: artifacts-dist-manifest + path: dist-manifest.json + # Create a GitHub Release while uploading all files to it + - name: "Download GitHub Artifacts" + uses: actions/download-artifact@v4 + with: + pattern: artifacts-* + path: artifacts + merge-multiple: true + - name: Cleanup + run: | + # Remove the granular manifests + rm -f artifacts/*-dist-manifest.json + - name: Create GitHub Release + env: + PRERELEASE_FLAG: "${{ fromJson(steps.host.outputs.manifest).announcement_is_prerelease && '--prerelease' || '' }}" + ANNOUNCEMENT_TITLE: "${{ fromJson(steps.host.outputs.manifest).announcement_title }}" + ANNOUNCEMENT_BODY: "${{ fromJson(steps.host.outputs.manifest).announcement_github_body }}" + RELEASE_COMMIT: "${{ github.sha }}" + run: | + # Write and read notes from a file to avoid quoting breaking things + echo "$ANNOUNCEMENT_BODY" > $RUNNER_TEMP/notes.txt + + gh release create "${{ needs.plan.outputs.tag }}" --target "$RELEASE_COMMIT" $PRERELEASE_FLAG --title "$ANNOUNCEMENT_TITLE" --notes-file "$RUNNER_TEMP/notes.txt" artifacts/* + + announce: + needs: + - plan + - host + # use "always() && ..." to allow us to wait for all publish jobs while + # still allowing individual publish jobs to skip themselves (for prereleases). + # "host" however must run to completion, no skipping allowed! + if: ${{ always() && needs.host.result == 'success' }} + runs-on: "ubuntu-22.04" + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + steps: + - uses: actions/checkout@v4 + with: + persist-credentials: false + submodules: recursive diff --git a/Cargo.lock b/Cargo.lock index c220ed41..dccd0984 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -1574,6 +1574,12 @@ name = "prometeu" version = "0.1.0" dependencies = [ "clap", + "cpal", + "pixels", + "prometeu-core", + "ringbuf", + "serde_json", + "winit", ] [[package]] @@ -1585,7 +1591,7 @@ dependencies = [ ] [[package]] -name = "prometeu-runtime-desktop" +name = "prometeu-runtime" version = "0.1.0" dependencies = [ "cpal", diff --git a/Cargo.toml b/Cargo.toml index 2b583ba5..f0584fe6 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,10 +1,16 @@ [workspace] members = [ "crates/prometeu-core", - "crates/prometeu-runtime-desktop", + "crates/prometeu-runtime", "crates/prometeu", ] resolver = "2" [workspace.package] license = "MIT" +repository = "https://github.com/prometeu/runtime" + +# The profile that 'dist' will build with +[profile.dist] +inherits = "release" +lto = "thin" diff --git a/README.md b/README.md index 399f74d3..03d2393a 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ This repository is organized as a Rust workspace and contains several components - **[crates/](./crates)**: Software implementation in Rust. - **[prometeu](./crates/prometeu)**: Unified command-line interface (CLI). - **[prometeu-core](./crates/prometeu-core)**: The logical core, VM, and internal OS. - - **[prometeu-runtime-desktop](./crates/prometeu-runtime-desktop)**: Host for execution on Desktop systems. + - **[prometeu-runtime](./crates/prometeu-runtime)**: Host for execution on Desktop systems. - **[docs/](./docs)**: Technical documentation and system specifications. - **[devtools-protocol/](./devtools-protocol)**: Definition of the communication protocol for development tools. - **[test-cartridges/](./test-cartridges)**: Cartridge examples and test suites. diff --git a/crates/prometeu-runtime-desktop/Cargo.toml b/crates/prometeu-runtime/Cargo.toml similarity index 55% rename from crates/prometeu-runtime-desktop/Cargo.toml rename to crates/prometeu-runtime/Cargo.toml index ba750bf1..78c7e893 100644 --- a/crates/prometeu-runtime-desktop/Cargo.toml +++ b/crates/prometeu-runtime/Cargo.toml @@ -1,8 +1,17 @@ [package] -name = "prometeu-runtime-desktop" +name = "prometeu-runtime" version = "0.1.0" edition = "2024" license.workspace = true +repository.workspace = true + +[[bin]] +name = "prometeu-runtime" +path = "src/main.rs" + +[package.metadata.dist] +dist = true +include = ["../../VERSION.txt"] [dependencies] prometeu-core = { path = "../prometeu-core" } diff --git a/crates/prometeu-runtime-desktop/README.md b/crates/prometeu-runtime/README.md similarity index 100% rename from crates/prometeu-runtime-desktop/README.md rename to crates/prometeu-runtime/README.md diff --git a/crates/prometeu-runtime-desktop/src/audio.rs b/crates/prometeu-runtime/src/audio.rs similarity index 100% rename from crates/prometeu-runtime-desktop/src/audio.rs rename to crates/prometeu-runtime/src/audio.rs diff --git a/crates/prometeu-runtime-desktop/src/cap.rs b/crates/prometeu-runtime/src/cap.rs similarity index 100% rename from crates/prometeu-runtime-desktop/src/cap.rs rename to crates/prometeu-runtime/src/cap.rs diff --git a/crates/prometeu-runtime-desktop/src/debugger.rs b/crates/prometeu-runtime/src/debugger.rs similarity index 100% rename from crates/prometeu-runtime-desktop/src/debugger.rs rename to crates/prometeu-runtime/src/debugger.rs diff --git a/crates/prometeu-runtime-desktop/src/fs_backend.rs b/crates/prometeu-runtime/src/fs_backend.rs similarity index 100% rename from crates/prometeu-runtime-desktop/src/fs_backend.rs rename to crates/prometeu-runtime/src/fs_backend.rs diff --git a/crates/prometeu-runtime-desktop/src/input.rs b/crates/prometeu-runtime/src/input.rs similarity index 100% rename from crates/prometeu-runtime-desktop/src/input.rs rename to crates/prometeu-runtime/src/input.rs diff --git a/crates/prometeu-runtime-desktop/src/log_sink.rs b/crates/prometeu-runtime/src/log_sink.rs similarity index 100% rename from crates/prometeu-runtime-desktop/src/log_sink.rs rename to crates/prometeu-runtime/src/log_sink.rs diff --git a/crates/prometeu-runtime-desktop/src/main.rs b/crates/prometeu-runtime/src/main.rs similarity index 100% rename from crates/prometeu-runtime-desktop/src/main.rs rename to crates/prometeu-runtime/src/main.rs diff --git a/crates/prometeu-runtime-desktop/src/runner.rs b/crates/prometeu-runtime/src/runner.rs similarity index 100% rename from crates/prometeu-runtime-desktop/src/runner.rs rename to crates/prometeu-runtime/src/runner.rs diff --git a/crates/prometeu-runtime-desktop/src/stats.rs b/crates/prometeu-runtime/src/stats.rs similarity index 100% rename from crates/prometeu-runtime-desktop/src/stats.rs rename to crates/prometeu-runtime/src/stats.rs diff --git a/crates/prometeu-runtime-desktop/src/utilities.rs b/crates/prometeu-runtime/src/utilities.rs similarity index 100% rename from crates/prometeu-runtime-desktop/src/utilities.rs rename to crates/prometeu-runtime/src/utilities.rs diff --git a/crates/prometeu/Cargo.toml b/crates/prometeu/Cargo.toml index bdecf668..e4ee0fe0 100644 --- a/crates/prometeu/Cargo.toml +++ b/crates/prometeu/Cargo.toml @@ -3,6 +3,37 @@ name = "prometeu" version = "0.1.0" edition = "2024" license.workspace = true +repository.workspace = true + +[[bin]] +name = "prometeu" +path = "src/main.rs" + +[[bin]] +name = "prometeu-runtime" +path = "../prometeu-runtime/src/main.rs" + +# Future binaries (commented) +# [[bin]] +# name = "prometeuc" +# path = "../prometeuc/src/main.rs" +# +# [[bin]] +# name = "prometeup" +# path = "../prometeup/src/main.rs" + +[package.metadata.dist] +dist = true +include = [ + "../../VERSION.txt", + "../../dist-staging/devtools-protocol" +] [dependencies] clap = { version = "4.5", features = ["derive"] } +prometeu-core = { path = "../prometeu-core" } +winit = "0.30.12" +pixels = "0.15.0" +cpal = "0.15.3" +ringbuf = "0.4.7" +serde_json = "1.0" diff --git a/crates/prometeu/devtools-protocol/protocol.json b/crates/prometeu/devtools-protocol/protocol.json new file mode 120000 index 00000000..2d11ba72 --- /dev/null +++ b/crates/prometeu/devtools-protocol/protocol.json @@ -0,0 +1 @@ +../../../devtools-protocol/protocol.json \ No newline at end of file diff --git a/crates/prometeu/src/main.rs b/crates/prometeu/src/main.rs index 43c51a6f..250c2a1b 100644 --- a/crates/prometeu/src/main.rs +++ b/crates/prometeu/src/main.rs @@ -116,41 +116,18 @@ fn dispatch(exe_dir: &Path, bin_name: &str, args: &[&str]) { let bin_path = get_binary_path(exe_dir, bin_name); if !bin_path.exists() { - // Tries to find the runtime with the exact name (prometeu-runtime-desktop) - // in case prometeu-runtime is just an alias or link that doesn't exist yet - let alt_bin_name = if bin_name == "prometeu-runtime" { - Some("prometeu-runtime-desktop") - } else { - None - }; - - let final_bin_path = if let Some(alt_name) = alt_bin_name { - let alt_path = get_binary_path(exe_dir, alt_name); - if alt_path.exists() { - alt_path - } else { - bin_path + eprintln!( + "prometeu: command '{}' is not yet available in this distribution", + match bin_name { + "prometeu-runtime" => "run/debug", + "prometeuc" => "build/verify c", + "prometeup" => "pack/verify p", + _ => bin_name, } - } else { - bin_path - }; - - if !final_bin_path.exists() { - eprintln!( - "prometeu: command '{}' is not yet available in this distribution", - match bin_name { - "prometeu-runtime" => "run/debug", - "prometeuc" => "build/verify c", - "prometeup" => "pack/verify p", - _ => bin_name, - } - ); - std::process::exit(1); - } - execute_bin(&final_bin_path, args); - } else { - execute_bin(&bin_path, args); + ); + std::process::exit(1); } + execute_bin(&bin_path, args); } fn execute_bin(bin_path: &Path, args: &[&str]) { diff --git a/dist-workspace.toml b/dist-workspace.toml new file mode 100644 index 00000000..3fc4fed2 --- /dev/null +++ b/dist-workspace.toml @@ -0,0 +1,15 @@ +[workspace] +members = ["cargo:."] + +# Config for 'dist' +[dist] +cargo-dist-version = "0.30.3" +ci = "github" +installers = [] +targets = ["aarch64-apple-darwin", "x86_64-apple-darwin"] +# Future targets (commented) +# targets = ["aarch64-apple-darwin", "x86_64-apple-darwin", "x86_64-unknown-linux-gnu", "x86_64-pc-windows-msvc"] +unix-archive = ".zip" +macos-universal-binaries = true +[dist.hooks] +pre-build = ["./scripts/gen-version.sh"] diff --git a/scripts/gen-version.sh b/scripts/gen-version.sh new file mode 100755 index 00000000..ba7a8e3b --- /dev/null +++ b/scripts/gen-version.sh @@ -0,0 +1,11 @@ +#!/bin/bash +# Get version from git tag or fallback to Cargo.toml version +VERSION=$(git describe --tags --abbrev=0 2>/dev/null || grep -m 1 '^version =' crates/prometeu-runtime/Cargo.toml | cut -d '"' -f 2 || echo "0.1.0") +echo "$VERSION" > VERSION.txt +echo "Generated VERSION.txt with version $VERSION" + +# Prepare staging for SDK extra files +echo "Preparing dist-staging..." +rm -rf dist-staging +mkdir -p dist-staging/devtools-protocol +cp devtools-protocol/protocol.json dist-staging/devtools-protocol/