Repository navigation
fix(ci): run the Go shards when a docs/project baseline changes - #1692
Merged
Merged
Conversation
Co-Authored-By: jason.han <hanhuijun@gmail.com>
Contributor
Author
|
I'll fix CI failures and address comments from users with write access. I'll skip comments containing "(aside)".
|
Co-Authored-By: jason.han <hanhuijun@gmail.com>
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
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.
What and why
scripts/ci-changed-areas.shclassified every file underdocs/project/as documentation alone (docs_patternmatches^docs/, nothing claims it forgo). The 13docs/project/*.jsonfiles are committed baselines that Go tests read —tools/referee/{apijson,diff,xpect,reject,pssm,fuml}provenance and figure checks,tools/census/{doccounts,manifest,transformation},tests/fixtures/librarycensus.go,tools/bench/llm— and thedocs/project/*.mdpages carry the figures those tests check (TestRecordStatesTheBaselinesFiguresintools/referee/apijson,doc_counts_test.goinreferee/diff,reject,xpect,tests/hygiene/compliance_identifiers_test.goover everydocs/project/*.md,tests/hygiene/release_digests_test.gooverdocs/project/archive/CHANGELOG-0.0-0.8.md).So a baseline-only re-record such as #1691 ran
go=false: the full tier was green on the pull request (and would be in the merge queue, which diffs the same range) while the Go shard that holds the test the re-record fixes was skipped. Only develop's post-merge CircleCI run, which runs everything, exercises it.This PR adds
project_inputs_pattern='^docs/project/.*\.(json|md)$'to the script and feeds it into thegoarea, alongsidehygiene_pattern.docsstill runs for those files; nothing else about the classification changes.Before / after on this branch's script, for a one-file change:
docs/project/pilot-differential-baseline.jsondocs/project/api-json-differential.mddocs/project/archive/CHANGELOG-0.0-0.8.mddocs/guide/01-install.md,README.md,packaging/man/man1/sysml.1internal/…,tools/…,examples/…,tests/…service_pattern)Other non-Go-suffixed Go-test inputs the script still classifies as non-
go(not changed here, follow-ups)Checked by grepping the Go tree for paths it reads and running the script over each:
docs/project/library-and-prefix-sweep-outcomes.txt— read bytests/fixtures/librarycensus.go;docsonly. The onedocs/projectinput outside.json/.md; this PR deliberately keeps to the two suffixes.docs/manual/examples/*.sysml— read bycmd/sysml/manual_examples_test.go(ten tests) and an input root of both referee baselines;docsonly.docs/assets/opensysml-stack.sysmlanddocs/assets/— read bytests/wasm/landing_model_test.goandtests/wasm/browser_repl_test.go;docsonly.docs/internals/architecture.md,README.md— figure-bearing pages read bytools/census/doccountsandtools/referee/diff/doc_counts_test.go;docsonly.docs/reference/rdf-mapping.md,docs/reference/sysml-v1-migration.md— read byinternal/translate/export/experimental_test.go;docs/reference/sysml-mcp.md,docs/guide/01-install.md,docs/guide/08-editors.md— read bytests/hygiene/mcp_alias_test.goandmcp_registry_test.go;docsonly..agents/skills/**/SKILL.md— read bytools/referee/{diff,reject,exec}doc-count tests;docsonly (via.*\.md$).editors/vscode/src/landing/*— read bytests/wasm/landing_model_test.go;vscodeonly.examples/,tests/, everytestdata/directory and every_test.goalready rungo(service_pattern/hygiene_pattern), so they are not gaps.How it was verified
bash scripts/ci-changed-areas-test.sh— all cases passed, including the three new full-tier casesproject-baseline,project-figures,project-archive(docs,go) and the quick-tierproject-baseline(docs,go);docs-onlystill yieldsdocs.shellcheck scripts/ci-changed-areas.sh scripts/ci-changed-areas-test.sh— clean.go test -count=1 ./tests/hygiene/...— ok.python3 scripts/changelog.py check— exit 0.origin/developscript and this branch's script side by side over the listed paths in a throwaway repository.Because the change touches
scripts/, this PR itself runs every area, so theChanged areasjob's own test step exercises the new cases in CI.Checklist
make testandmake lintpass locally (the script's test, hygiene suite and changelog check; no Go code changed)changes/unreleased/ci-baseline-json-runs-go.fixed.mdmake docs-countsrun if a gate count moved (no count moved)Link to Devin session: https://nasa-jpl-demo.devinenterprise.com/sessions/02c00bfac5574bdb91cc5179ca1fc86c
Open in Devin Desktop: https://nasa-jpl-demo.devinenterprise.com/desktop/session/02c00bfac5574bdb91cc5179ca1fc86c?variant=devin
Requested by: @HuiJun