Skip to content

docs(editors): state that editor versions are independent of the core - #744

Closed
devin-ai-integration[bot] wants to merge 1 commit into
developfrom
feature/editor-version-independence
Closed

devin-ai-integration[bot] wants to merge 1 commit into
developfrom
feature/editor-version-independence

Conversation

@devin-ai-integration

Copy link
Copy Markdown
Contributor

What and why

The clients now release in lockstep with the core version. The editors' own version fields, however, still read 0.1.0 / 0.1.0-SNAPSHOT:

  • editors/vscode/package.json
  • editors/syson/frontend/package.json
  • editors/cameo/pom.xml
  • editors/syson/pom.xml

That reads as drift. The decision is to keep the editors versioned on their own, so this PR documents that:

  • editors/README.md gets a new Versions section. It says each editor keeps its own version and a core release does not bump it. It also says the client references the editors build against (opensysml.client.version in the Cameo pom, and the opensysml-client dependency in the SysON backend pom) are locked to client/java/pom.xml, and names the existing gate that enforces this: test_every_in_repo_reference_names_the_poms_version in client/python/tests/test_check_version.py, which the PR workflow runs whenever either editor pom changes (via scripts/ci-changed-areas.sh).
  • docs/project/releasing.md: the release-branch bump step now says the editors' own versions are not bumped, and links to that section.

No code, tests or gates change, and there is no changelog fragment because nothing a user sees changes.

How it was verified

  • python3 scripts/check-doc-links.py: 0 broken links.
  • make docs-check passes.
  • python3 scripts/changelog.py check passes.
  • The named test passes on develop: pytest tests/test_check_version.py -k in_repo_reference.

Checklist

  • make test and make lint pass locally (n/a: docs only)
  • Tests added or updated for the change (n/a: documents an existing test)
  • Documentation extended where it already covers the surface (see CONTRIBUTING.md)
  • Changelog entry added as changes/unreleased/<slug>.<section>.md, not as an edit to CHANGELOG.md (n/a: nothing a user sees changes)
  • baselines regenerated and make docs-counts run if a gate count moved (n/a)
  • No internal work-item labels (waves, slices, F4, K5) in the body, docs, or changelog

Link to Devin session: https://nasa-jpl-demo.devinenterprise.com/sessions/50e350d0913749039440892f390a0f90
Open in Devin Desktop: https://nasa-jpl-demo.devinenterprise.com/desktop/session/50e350d0913749039440892f390a0f90?variant=devin
Requested by: @HuiJun

Co-Authored-By: jason.han <hanhuijun@gmail.com>
@devin-ai-integration

Copy link
Copy Markdown
Contributor Author

I'll fix CI failures and address comments from users with write access. I'll skip comments containing "(aside)".

  • Disable automatic comment, CI, and merge conflict monitoring

@devin-ai-integration

Copy link
Copy Markdown
Contributor Author

Superseded: the editors' versions are being locked to the core version in a separate PR instead of documented as independent.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant