Rename the build record's fields and the code around them - #1277
Merged
Merged
Conversation
Nothing has shipped, so the names can still change. The record's `request` is now `configuration`, with `cpp_options`, `stanc_options`, `stanc_options_added` and `stanc_options_from_make` inside it, since cmdstanr injects nothing into `cpp_options` and the plain names mean what the arguments mean. `artifact` is `executable_hash`, `builder` is `cmdstan`, `known_untracked_dependencies` is `untracked_dependencies`, and the reason for a record that does not match its executable is `executable_mismatch`. The public result's `provenance` becomes `record`. The code follows: `read_current_build()` replaces `observe_build()`, `assess_build()` takes what is wanted and what is current, `stancflags_added_by_make()` replaces `inherited_stancflags()`, and the facts a model keeps about its executable come from `facts_from_record()`. Comments and test titles drop the design doc's vocabulary where it named these things. Part of #1258.
Nothing has shipped, so the names can still change. The record's `request` is now `configuration`, with `cpp_options`, `stanc_options`, `stanc_options_added` and `stanc_options_from_make` inside it, since cmdstanr injects nothing into `cpp_options` and the plain names mean what the arguments mean. `artifact` is `executable_hash`, `builder` is `cmdstan`, `known_untracked_dependencies` is `untracked_dependencies`, and the reason for a record that does not match its executable is `executable_mismatch`. The public result's `provenance` becomes `record`. The code follows: `read_current_build()` replaces `observe_build()`, `assess_build()` takes what is wanted and what is current, `stancflags_added_by_make()` replaces `inherited_stancflags()`, and the facts a model keeps about its executable come from `facts_from_record()`. Comments and test titles drop the design doc's vocabulary where it named these things. Part of #1258.
…dstanr into rename-record-fields
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## v1.0 #1277 +/- ##
=======================================
Coverage ? 93.25%
=======================================
Files ? 17
Lines ? 7068
Branches ? 0
=======================================
Hits ? 6591
Misses ? 477
Partials ? 0 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
jgabry
marked this pull request as ready for review
September 18, 2026 16:26
This was referenced Sep 18, 2026
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Submission Checklist
Summary
This PR and the summary below were assisted by AI. I have reviewed all code and doc.
Part of #1258. Nothing has shipped, so the names can still change; after 1.0 they cannot.
Record fields:
requestis nowconfiguration, holdingcpp_options,stanc_options,stanc_options_added,stanc_options_from_make,stanc_nameandinclude_paths.artifactisexecutable_hash,builderiscmdstan,known_untracked_dependenciesisuntracked_dependencies, and the reason for a record that does not match its executable isexecutable_mismatch. The public result'sprovenancebecomesrecord, still nested withstatusandreason.Internals follow so the public result stays the record narrowed rather than translated:
read_current_build()replacesobserve_build(),assess_build()takes what is wanted and what is current,stancflags_added_by_make()replacesinherited_stancflags(), and the facts a model keeps about its executable come fromfacts_from_record(). Comments and test titles drop the design doc's vocabulary (guard, snapshot, unprovenanced, injected, inherited) where it named these things. The design doc changes only where it names a field; the contract is regenerated.Targeted test files run locally: test-build-record, test-build-assess, test-build-record-compile, test-model-guard, test-model-rebuild-rules, test-model-rebuild, test-cpp_opts, test-utils, test-model-compile, all passing.
Copyright and Licensing
Please list the copyright holder for the work you are submitting
(this will be you or your assignee, such as a university or company):
Jonah Gabry
By submitting this pull request, the copyright holder is agreeing to
license the submitted work under the following licenses: