Repository navigation
chore(docs): name the project OpenSysML MDK - #1324
Merged
Merged
Conversation
The brand is OpenSysML MDK, the second generation of OpenMBEE's Model Development Kit; the description, repository, module path, package and registry names, binaries, environment variables and RE/DK build names are unchanged. 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)".
|
With the product named OpenSysML MDK, the Cameo Systems Modeler plugin takes a qualifier in every display name: README, Maven project names, the plugin descriptor, dialog titles, the docs and the CI job name. Its Maven coordinates, plugin id, Java packages and the DocGen profile name are unchanged. Co-Authored-By: jason.han <hanhuijun@gmail.com>
Contributor
Author
There was a problem hiding this comment.
🔍 Devin Review: 1 flag
Not posted on this PR by your GitHub settings — view it in Devin Review. (Configure)
…he OpenSysML suite 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
The project is named OpenSysML MDK, the second generation of OpenMBEE's Model Development Kit. The one-line description stays "Runtime Environment and Development Kit"; only the "REDK" acronym and the display names derived from it change, in
README.md,CONTRIBUTING.md,AGENTS.md,mkdocs.yml(site_name), the landing page (overrides/home.html),docs/README.md,docs/documentation.md,docs/community.mdanddocs/reference/wasm.md. The README title drops its "(MDK2)" subtitle; the sentence explaining that this is the second generation of OpenMBEE's MDK stays.Unchanged, because they are identifiers rather than the brand: the repository
Open-MBEE/OpenSysML, the Go module pathgithub.com/Open-MBEE/OpenSysML, every package and registry name (opensysml,@openmbee/opensysml*,org.openmbee:opensysml*, crateopensysml,jupyter-opensysml-kernel,org.opensysml/sysml-mcp), binary and release-asset names,OPENSYSML_*environment variables, the domainsopensysml.org/runtime.opensysml.org, file and directory names, the MSIUpgradeCode,site_description, the logos (OpenSysML wordmark only), and the product name "OpenSysML" wherever it stands alone. No Go source, manifest (action.yml, MSI, winget, Homebrew, Conda, MCPserver.json, VS Codepackage.json), client README or agent skill said "REDK"; none is touched.RE/DK build names. The two
sysmlbuilds (-tags sysml_re,make build-re,bin/re/sysml) keep their names: they derive from the description, not the acronym.docs/reference/wasm.mdand the unreleased fragmentchanges/unreleased/re-dk-build-names.changed.mdnow say they are "named after the two halves of the Runtime Environment and Development Kit"; nothing else in that fragment changes.editors/mdk: OpenSysML MDK for Cameo. The Cameo Systems Modeler plugin was itself named "OpenSysML MDK"; with the product carrying that name, its display name becomes OpenSysML MDK for Cameo everywhere a human reads it: the README heading and first paragraph (which now distinguishes the kit from the plugin), the Maven<name>of the five modules, thenameattribute ofMDR_Plugin_OpenSysML_MDK_descriptor.xmland of the descriptorPluginDescriptorWritergenerates, the dialog and session titles inOperationActionsandDocGenExtensions, the Javadoc and error messages inPluginLocatorandBridgeResult, thepr.ymljob name, and the headings and prose ofdocs/internals/design/mdk-plugin.md,docs/project/mdk-parity.md,docs/internals/design/README.mdandeditors/README.md. Unchanged: MavengroupId/artifactId(org.openmbee:opensysml-mdk-*), the Java packageorg.openmbee.opensysml.mdk,PluginLocator.PLUGIN_ID, the descriptor file name, directory names, and theOpenSysML MDK DocGenprofile name thatDocGenExtensions.PROFILE_NAMEwrites into users' models.CHANGELOG.mdanddocs/project/archive/CHANGELOG-0.0-0.8.mdare not edited (git diff origin/develop -- CHANGELOG.md docs/project/archive/is empty); the change is recorded inchanges/unreleased/mdk-brand-name.changed.md. After this changegit grep -w REDKoutside those two files matches only that fragment's sentence about the former name.Satellites:
Open-MBEE/OpenSysML-REDK-Skillsis being renamed toOpen-MBEE/OpenSysML-MDK-Skillsseparately (this tree does not reference that slug);Open-MBEE/opensysml.github.iosays "OpenSysML REDK" in itsindex.htmland gets its own PR there.How it was verified
All on this branch at its head, Linux, Go 1.25, Node 24, Maven 3.9.9 / JDK 17:
gofmt -l .empty;go build ./...andgo vet ./...clean.go test -count=1 ./...with the training corpus, pilot corpora, pilot library XMI and PSSM suite fetched: pass (includes./tests/hygiene/...,./tests/wasm/...,./internal/frontend/...; no fixture is touched).python3 scripts/changelog.py check,python3 scripts/check-doc-ids.py,make docs-check(link checker, aftermake docs-landing-assets),go run -C tools ./cmd/doc-counts -check("already current"): pass. No README or docs figure moved.mkdocs build --strict(aftermake docs-engine-assets): pass.editors/vscode:npm ci && npm test: 342 passed, 0 failed. The landing model's pinned description "Runtime Environment and Development Kit" (src/landing/stack.json,model.test.ts,tests/wasm/landing_model_test.go,docs/assets/opensysml-stack.sysml) is unchanged.editors/mdk:mvn -B -q -f client/java/pom.xml -pl :opensysml -am install -DskipTeststhenmvn -B -f editors/mdk/pom.xml verify -Dopensysml.requireService=trueagainst a freshly builtbin/sysml-grpc: 50 tests, 0 failures, BUILD SUCCESS.DocGenExtensionsTeststill asserts theOpenSysML MDK DocGenprofile name.Known red that this branch inherits from
develop(not caused here, not fixed here):TestCommittedBaselineStatesThisRepositorysProvenanceintools/referee/apijsonfails identically on bareorigin/develop(119515349), becausedocs/project/api-json-differential-baseline.jsonrecords 30 testdata files and the errata registry digest of an earlier tree, while the repository now has 32 files and a newer registry. It needsgo run -C tools ./cmd/pilot-apijson-diff -updateafter adjudication, which is outside a brand rename; this branch touches nothing undertools/. It is what fails the "Go tests (rest migrate)" shard on this PR; #1321 and #1322 re-record that baseline, and this branch has no overlap with either.Overlaps with open PRs: #1302/#1307/#1313/#1315 edit
AGENTS.md,CONTRIBUTING.md,README.mdand.github/workflows/pr.yml, #1318/#1275/#1308 editREADME.md, on lines this PR does not touch. The branchdocs/community-project-cards(no PR) rewritesdocs/community.md, including the two lines renamed here.Checklist
make testandmake lintpass locally (go test ./...apart from thedevelop-inherited baseline red above;gofmt/go vetclean)changes/unreleased/<slug>.<section>.md, not as an edit toCHANGELOG.mdmake docs-countsrun if a gate count moved (compliance rows need nothing: the census is counted at docs build) — nothing moved;doc-counts -checkis currentF4,K5) in the body, docs, or changelogLink to Devin session: https://nasa-jpl-demo.devinenterprise.com/sessions/b3a9f2862c6f44c49dcb8f9535de812f
Open in Devin Desktop: https://nasa-jpl-demo.devinenterprise.com/desktop/session/b3a9f2862c6f44c49dcb8f9535de812f?variant=devin
Requested by: @HuiJun