unisonweb/unison
1
0
Fork 0
mirror of https://github.com/unisonweb/unison.git synced 2024-09-11 02:25:39 +03:00
Code Issues Projects Releases Wiki Activity

refactor ci.yaml with jit setup steps (attempt 1)

Browse Source 
recommend moving support scheme files to another repo
if they aren't deeply related to ucm; but maybe they are.
This commit is contained in:
Arya Irani 2024-02-11 21:02:04 -05:00
parent 038550ced3
commit b3cad2ce2a
4 changed files with 230 additions and 80 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

234
.github/workflows/ci.yaml vendored
View File

@ -17,9 +17,25 @@ on:
- release/*
workflow_dispatch:
env:
ormolu_version: "0.5.0.1"
racket_version: "8.7"
jit_version: "@unison/internal/releases/0.0.10"
jit_src_scheme: "${{$HOME}}/unison-jit-src/scheme-libs/racket"
jit_bin: "${{$HOME}}/unison-jit-bin"
jit_generator_os: ubuntu-20.04
jit_codebase: "${{$HOME}}/unison-jit-codebase"
matrix:
os:
# While iterating on this file, you can disable one or more of these to speed things up
- ubuntu-20.04
- macOS-12
- windows-2019
jobs:
ormolu:
runs-on: ubuntu-20.04
# Only run formatting on trunk commits
@ -39,7 +55,7 @@ jobs:
separator: "\n"
- uses: haskell-actions/run-ormolu@v14
with:
version: "0.5.0.1"
version: ${{ env.ormolu_version }}
mode: inplace
pattern: ${{ steps.changed-files.outputs.all_changed_files }}
- name: apply formatting changes
@ -47,33 +63,20 @@ jobs:
if: ${{ always() }}
with:
commit_message: automatically run ormolu
build:
name: ${{ matrix.os }}
build-ucm:
name: Build UCM ${{ matrix.os }}
runs-on: ${{ matrix.os }}
# The 'always()' causes this to build even if the ormolu job is skipped.
if: ${{ always() }}
needs: ormolu
defaults:
run:
shell: bash
strategy:
# Run each build to completion, regardless of if any have failed
fail-fast: false
matrix:
os:
# While iterating on this file, you can disable one or more of these to speed things up
- ubuntu-20.04
- macOS-12
- windows-2019
steps:
- uses: actions/checkout@v2
# The number towards the beginning of the cache keys allow you to manually avoid using a previous cache.
# GitHub will automatically delete caches that haven't been accessed in 7 days, but there is no way to
# purge one manually.
- id: stackage-resolver
name: record stackage resolver
# https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#environment-files
@ -172,19 +175,6 @@ jobs:
if: runner.os == 'macOS'
run: rm -rf ~/.stack/setup-exe-cache
- name: install stack-clean-old (to scan or clean up old stackage caches)
run: |
if ! stack exec -- which stack-clean-old; then
stack install stack-clean-old
fi
- name: check initial stackage cache size
run: |
echo global .stack
stack exec -- stack-clean-old list -G || true
echo project .stack-work
stack exec -- stack-clean-old list -P || true
# Build deps, then build local code. Splitting it into two steps just allows us to see how much time each step
# takes.
- name: build dependencies
@ -249,51 +239,164 @@ jobs:
git diff --cached --ignore-cr-at-eol --exit-code
- name: cli-integration-tests
run: stack --no-terminal exec cli-integration-tests
- name: Cache Racket dependencies
uses: actions/cache@v2
- name: verify stack ghci startup
if: runner.os == 'macOS'
run: echo | stack ghci
- name: save ucm artifact
uses: actions/upload-artifact@v4
with:
name: unison-${{ matrix.os }}
path: $(stack exec -- which unison)
generate-jit-source:
name: Generate JIT source
needs: build-ucm
runs-on: ${{ env.jit_generator_os }}
steps:
- uses: actions/cache@v3
name: cache jit source
if: runner.os == 'Linux'
with:
path: ${{ env.jit_src_scheme }}
key: jit_src_scheme.racket_${{env.racket_version}}.jit_${{jit_src}}.${{github.sha}}
restore-keys: jit_src_scheme.racket_${{env.racket_version}}.jit_${{jit_src}}.
- name: check source exists
id: jit_src_exists
uses: thebinaryfelix/check-file-existence-action@v1
with:
files: "${{ env.jit_src_scheme }}/unison/{data-info,boot-generated,simple-wrappers,builtin-generated,compound-wrappers}.ss"
- name: create transcript
if: steps.jit_src_exists.outputs.exists == 'false'
uses: 1arp/create-a-file-action@0.3
with:
file: 'setup-jit.md'
content: |
```ucm
.> project.create-empty jit-setup
jit-setup/main> pull ${{ env.jit_version }} lib.jit
```
```unison
generateSchemeBoot dir = do
saveDataInfoFile dir dataInfos
saveBaseFile dir bootSpec
saveWrapperFile dir simpleWrapperSpec
saveBaseFile dir builtinSpec
saveWrapperFile dir compoundWrapperSpec
go = generateSchemeBoot "${{ env.jit_src_scheme }}"
```
```ucm
jit-setup/main> run go
```
- name: download ucm artifact
if: steps.jit_src_exists.outputs.exists == 'false'
uses: actions/download-artifact@v4
with:
name: unison-${{ env.jit_generator_os }}
path: ./
- name: generate source
if: steps.jit_src_exists.outputs.exists == 'false'
run: |
cp -R scheme-libs/racket/* ${{ env.jit_src_scheme }}
chmod +x unison-${{ env.jit_generator_os }}
unison-${{ env.jit_generator_os }} transcript setup-jit.md
- name: save jit source
if: steps.jit_src_exists.outputs.exists == 'false'
uses: actions/upload-artifact@v4
with:
name: jit-source
path: ${{ env.jit_src_scheme }}/**
build-jit-binary:
name: Build JIT binary ${{ matrix.os }}
needs: [build-ucm, generate-jit-source]
runs-on: ${{ matrix.os }}
env:
ucm: ${{ runner.temp }}/unison-${{ matrix.os }}
steps:
- name: cache jit binaries
uses: actions/cache@v3
with:
path: ${{ env.jit_bin }}
key: jit_bin.racket_${{env.racket_version}}.jit_${{jit_src}}.${{github.sha}}
restore-keys: jit_bin.racket_${{env.racket_version}}.jit_${{jit_src}}.
- name: check binary exists
id: jit_bin_exists
uses: thebinaryfelix/check-file-existence-action@v1
with:
files: "${{ env.jit_bin }}/unison-runtime"
- name: Cache Racket dependencies
if: steps.jit_bin_exists.outputs.exists == 'false'
uses: actions/cache@v3
with:
path: |
~/.cache/racket
~/.local/share/racket
key: ${{ runner.os }}-racket-8.7
- uses: Bogdanp/setup-racket@v1.10
if: runner.os == 'Linux'
key: ${{ runner.os }}-racket-${{env.racket_version}}
- uses: Bogdanp/setup-racket@v1.11
# if: steps.jit_bin_exists.outputs.exists == 'false'
with:
architecture: 'x64'
distribution: 'full'
variant: 'CS'
version: '8.7' # match with cache key above
- run: raco pkg install --auto --skip-installed --batch x509-lib
if: runner.os == 'Linux'
version: ${{env.racket_version}}
- uses: awalsh128/cache-apt-pkgs-action@latest
# read this if a package isn't installing correctly
# https://github.com/awalsh128/cache-apt-pkgs-action#caveats
if: runner.os == 'Linux'
with:
packages: libb2-dev
version: 1.0 # cache key version afaik
- uses: actions/cache@v3
name: cache base.md codebase (unix)
if: runner.os == 'Linux'
- name: download jit source
# if: steps.jit_src_exists.outputs.exists == 'false'
uses: actions/download-artifact@v4
with:
path: ~/.cache/unisonlanguage/base.unison
key: base.unison_${{hashFiles('**/unison-src/builtin-tests/base.md','**/unison-cli/src/Unison/JitInfo.hs')}}-${{github.sha}}
restore-keys: base.unison_${{hashFiles('**/unison-src/builtin-tests/base.md','**/unison-cli/src/Unison/JitInfo.hs')}}-
name: jit-source
path: ${{ env.jit_src_scheme }}
- name: set up `base` codebase
if: runner.os == 'Linux'
run: |
./unison-src/builtin-tests/setup-base-codebase.sh
- uses: actions/checkout@v2 # checkout scheme-libs from unison repo
# if: steps.jit_src_exists.outputs.exists == 'false'
- name: jit tests
# if: false # temporarily disabled
if: runner.os == 'Linux'
- name: download ucm
# if: steps.jit_bin_exists.outputs.exists == 'false'
uses: actions/download-artifact@v4
with:
name: unison-${{ matrix.os }}
path: ${{ runner.temp }}
- run: |
chmod +x ${{ env.ucm }}
${{ env.ucm }} transcript setup-jit.md
- name: build jit binary
# if: steps.jit_bin_exists.outputs.exists == 'false'
run: |
./unison-src/builtin-tests/jit-tests.sh
cat ./unison-src/builtin-tests/jit-tests.output.md
cp -R scheme-libs/racket/* ${{ env.jit_src_scheme }}
raco pkg install --auto ${{ env.jit_src_scheme }}/unison
raco exe ${{ env.jit_src_scheme }}/unison-runtime.rkt
raco distribute ${{ env.jit_bin }} ${{ env.jit_src_scheme }}
-name: save jit binary
# if: steps.jit_bin_exists.outputs.exists == 'false'
uses: actions/upload-artifact@v4
with:
name: jit-binary-${{ matrix.os }}
path: ${{ env.jit_bin }}/**
- name: jit tests ${{ matrix.os }}
# if: steps.jit_bin_exists.outputs.exists == 'false'
run: |
time ${{ env.ucm }} transcript unison-src/builtin-tests/jit-tests.md
cat unison-src/builtin-tests/jit-tests.output.md
CHANGE=$(git diff unison-src/builtin-tests/jit-tests.output.md)
if [ -n "$CHANGE" ]; then
echo "The jit-tests output has changed"
@ -301,23 +404,12 @@ jobs:
fi
- name: interpreter tests
# if: false # temporarily disabled
if: runner.os == 'Linux'
# if: steps.jit_bin_exists.outputs.exists == 'false'
run: |
./unison-src/builtin-tests/interpreter-tests.sh
cat ./unison-src/builtin-tests/interpreter-tests.output.md
time ${{ env.ucm }} transcript unison-src/builtin-tests/interpreter-tests.md
cat unison-src/builtin-tests/interpreter-tests.output.md
CHANGE=$(git diff unison-src/builtin-tests/interpreter-tests.output.md)
if [ -n "$CHANGE" ]; then
echo "The interpreter-tests output has changed"
exit 1
fi
- name: verify stack ghci startup
if: runner.os == 'macOS'
run: echo | stack ghci
- name: check final stackage cache size
run: |
echo global .stack
stack exec -- stack-clean-old list -G || true
echo project .stack-work
stack exec -- stack-clean-old list -P || true

2
unison-src/builtin-tests/jit-tests.md
View File

@ -2,8 +2,6 @@
Note: This should be forked off of the codebase created by base.md
```ucm:hide
.> compile.native.fetch
.> compile.native.genlibs
.> load unison-src/builtin-tests/testlib.u
.> add
```

29
unison-src/transcripts-manual/gen-racket-libs.md
View File

@ -1,11 +1,26 @@
Fetch base, then fetch the compiler, then build the generated
libraries in the racket directory.
When we start out, `./scheme-libs/racket` contains a bunch of library files that we'll need. They define the Unison builtins for Racket.
Next, we'll download the jit project and generate a few Racket files from it.
```ucm
.> pull @unison/base/releases/2.5.0 .base
.> compile.native.fetch
.> compile.native.genlibs scheme-libs/racket
.> project.create-empty jit-setup
jit-setup/main> pull @unison/internal/releases/0.0.10 lib.jit
```
```unison
generateSchemeBoot dir = do
saveDataInfoFile dir dataInfos
saveBaseFile dir bootSpec
saveWrapperFile dir simpleWrapperSpec
saveBaseFile dir builtinSpec
saveWrapperFile dir compoundWrapperSpec
go = generateSchemeBoot "scheme-libs/racket"
```
```ucm
jit-setup/main> run go
```
After executing this, `scheme-libs/racket` will contain the full
@ -20,11 +35,11 @@ them. This is accomplished by running.
in the directory where the `unison` directory is located. Then the
runtime executable can be built with
raco exe scheme-libs/racket/ucr.rkt
raco exe scheme-libs/racket/unison-runtime.rkt
and a distributable directory can be produced with:
raco distribute <output-dir> scheme-libs/racket/ucr
raco distribute <output-dir> scheme-libs/racket/unison-runtime
At that point, <output-dir> should contain the executable and all
dependencies necessary to run it.

45
unison-src/transcripts-manual/gen-racket-libs.output.md Normal file
View File

@ -0,0 +1,45 @@
Fetch base, then fetch the compiler, then build the generated
libraries in the racket directory.
```ucm
.> pull @unison/base/releases/2.5.0 .base
Downloaded 12426 entities.
✅
Successfully pulled into .base, which was empty.
.> compile.native.fetch
Downloaded 1465 entities.
✅
Successfully updated .unison.internal from
@unison/internal/releases/0.0.10.
.> compile.native.genlibs scheme-libs/racket
```
After executing this, `scheme-libs/racket` will contain the full
complement of unison libraries for a given combination of ucm version
and @unison/internal version.
To set up racket to use these files, we need to create a package with
them. This is accomplished by running.
raco pkg install -t dir unison
in the directory where the `unison directory is located. Then the
runtime executable can be built with
raco exe scheme-libs/racket/ucr.rkt
and a distributable directory can be produced with:
raco distribute <output-dir> scheme-libs/racket/ucr
At that point, <output-dir> should contain the executable and all
dependencies necessary to run it.