Skip to content

Avoid duplicating YAML info in Markdown #5227

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 16, 2024
Merged

Avoid duplicating YAML info in Markdown #5227

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 1 addition & 16 deletions .github/workflows/ci.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,23 +6,8 @@ At a high level, the CI process is:
3. On all platforms, build the `unison-runtime` Racket program save the resulting binaries as build artifacts.

### `env` vars at the top of `CI.yaml`:
Some version numbers that are used during CI:
- `ormolu_version: "0.5.0.1"`
- `racket_version: "8.7"`
- `jit_version: "@unison/internal/releases/0.0.18"`

Some cached directories:
- `ucm_local_bin` a temp path for caching a built `ucm`
- `jit_src_scheme` a temp path for caching generated jit sources
- `unison-jit-dist`
- `base-codebase` a codebase path for caching a codebase generated by `unison-src/builtin-tests/base.md`
- `unison_src_test_results` a temp path for caching the result of passing tests that depend on `unison-src/`, which includes:
- `round-trip-tests`
- `transcripts`
- `unison-src/builtin-tests/interpreter-tests.md`

`jit_generator_os: ubuntu-20.04`
- afaik, the jit sources are generated in a platform-independent way, so we just choose one platform to generate them on.
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.

### Cached directories:

Expand Down
17 changes: 12 additions & 5 deletions .github/workflows/ci.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,19 +12,26 @@ on:
workflow_dispatch:

env:
ormolu_version: 0.5.2.0
ucm_local_bin: ucm-local-bin
## Some version numbers that are used during CI
Copy link
Contributor

@aryairani aryairani Jul 16, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel like some editor told me having comments in here was illegal, but I guess it's not true

ormolu_version: 0.7.2.0
jit_version: "@unison/internal/releases/0.0.18"
runtime_tests_version: "@unison/runtime-tests/main"

## Some cached directories
# a temp path for caching a built `ucm`
ucm_local_bin: ucm-local-bin
# a temp path for caching generated jit sources
jit_src_scheme: unison-jit-src/scheme-libs/racket
jit_dist: unison-jit-dist
jit_generator_os: ubuntu-20.04
runtime_tests_version: "@unison/runtime-tests/main"
# a codebase path for caching a codebase generated by `unison-src/builtin-tests/interpreter-tests.md`
runtime_tests_codebase: "~/.cache/unisonlanguage/runtime-tests.unison"

# locations of some files that will indicate whether we need to re-run certain steps
transcript_test_results: transcript-test-results
interpreter_test_results: interpreter-test-results

## afaik, the jit sources are generated in a platform-independent way, so we choose one platform to generate them on.
jit_generator_os: ubuntu-20.04

jobs:
ormolu:
runs-on: ubuntu-20.04
Expand Down