Skip to content

Commit 960f7d1

Browse files
committed
Avoid duplicating YAML info in Markdown
Reviewing the last merge into #5142, I noticed some duplicated and out- of-date information. This brings things up-to-date and slightly reduces the duplication. - bumped Ormolu used by ci.yaml from 0.5.2.0 to 0.7.2.0, to match flake.nix - removed Markdown that claimed ci.yaml was using Ormolu 0.5.0.1 - moved description from `base-codebase` in Markdown to comment on `runtime_tests_codebase` in ci.yaml (and updated it to refer to builtin-tests/interpreter-tests.md instead of builtin-tests/base.md) - removed `unison_src_test_results` as it’s no longer managed as a single variable - moved other comments from Markdown to ci.yaml - added Markdown recommending to look in ci.yaml for specifics - rearranges the order of vars in ci.yaml to match the order they were presented in Markdown One thing I wasn’t sure how to map over: Markdown claims Racket 8.7 is used in CI, but ci.yaml doesn’t mention any Racket version.
1 parent 7019595 commit 960f7d1

File tree

2 files changed

+13
-21
lines changed

2 files changed

+13
-21
lines changed

.github/workflows/ci.md

Lines changed: 1 addition & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -6,23 +6,8 @@ At a high level, the CI process is:
66
3. On all platforms, build the `unison-runtime` Racket program save the resulting binaries as build artifacts.
77

88
### `env` vars at the top of `CI.yaml`:
9-
Some version numbers that are used during CI:
10-
- `ormolu_version: "0.5.0.1"`
11-
- `racket_version: "8.7"`
12-
- `jit_version: "@unison/internal/releases/0.0.18"`
13-
14-
Some cached directories:
15-
- `ucm_local_bin` a temp path for caching a built `ucm`
16-
- `jit_src_scheme` a temp path for caching generated jit sources
17-
- `unison-jit-dist`
18-
- `base-codebase` a codebase path for caching a codebase generated by `unison-src/builtin-tests/base.md`
19-
- `unison_src_test_results` a temp path for caching the result of passing tests that depend on `unison-src/`, which includes:
20-
- `round-trip-tests`
21-
- `transcripts`
22-
- `unison-src/builtin-tests/interpreter-tests.md`
239

24-
`jit_generator_os: ubuntu-20.04`
25-
- afaik, the jit sources are generated in a platform-independent way, so we just choose one platform to generate them on.
10+
These variables pin some dependency versions, set up some directories to cache, etc. Please see the `env` section in [ci.yaml](./ci.yaml) for specifics.
2611

2712
### Cached directories:
2813

.github/workflows/ci.yaml

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,19 +12,26 @@ on:
1212
workflow_dispatch:
1313

1414
env:
15-
ormolu_version: 0.5.2.0
16-
ucm_local_bin: ucm-local-bin
15+
## Some version numbers that are used during CI
16+
ormolu_version: 0.7.2.0
1717
jit_version: "@unison/internal/releases/0.0.18"
18+
runtime_tests_version: "@unison/runtime-tests/main"
19+
20+
## Some cached directories
21+
# a temp path for caching a built `ucm`
22+
ucm_local_bin: ucm-local-bin
23+
# a temp path for caching generated jit sources
1824
jit_src_scheme: unison-jit-src/scheme-libs/racket
1925
jit_dist: unison-jit-dist
20-
jit_generator_os: ubuntu-20.04
21-
runtime_tests_version: "@unison/runtime-tests/main"
26+
# a codebase path for caching a codebase generated by `unison-src/builtin-tests/interpreter-tests.md`
2227
runtime_tests_codebase: "~/.cache/unisonlanguage/runtime-tests.unison"
23-
2428
# locations of some files that will indicate whether we need to re-run certain steps
2529
transcript_test_results: transcript-test-results
2630
interpreter_test_results: interpreter-test-results
2731

32+
## afaik, the jit sources are generated in a platform-independent way, so we choose one platform to generate them on.
33+
jit_generator_os: ubuntu-20.04
34+
2835
jobs:
2936
ormolu:
3037
runs-on: ubuntu-20.04

0 commit comments

Comments
 (0)