Avoid duplicating YAML info in Markdown #5227
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Reviewing the last merge into unisonweb#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.
aryairani
reviewed
Jul 16, 2024
| @@ -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 | |||
There was a problem hiding this comment.
I feel like some editor told me having comments in here was illegal, but I guess it's not true
aryairani
approved these changes
Jul 16, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview
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.
Implementation notes
base-codebasein Markdown to comment onruntime_tests_codebasein ci.yaml (and updated it to refer to builtin-tests/interpreter-tests.md instead of builtin-tests/base.md)unison_src_test_resultsas it’s no longer managed as a single variableTest coverage
This bumps the Ormolu version in ci.yaml, but otherwise just rearranges some items in that file. Running CI should catch if any of that is incorrect.
Loose ends
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.