docs(editors): state that editor versions are independent of the core - #744
Closed
devin-ai-integration[bot] wants to merge 1 commit into
Closed
devin-ai-integration[bot] wants to merge 1 commit into
devin-ai-integration[bot] wants to merge 1 commit into
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)".
|
Contributor
Author
|
Superseded: the editors' versions are being locked to the core version in a separate PR instead of documented as independent. |
4 of 6 tasks
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 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.jsoneditors/syson/frontend/package.jsoneditors/cameo/pom.xmleditors/syson/pom.xmlThat reads as drift. The decision is to keep the editors versioned on their own, so this PR documents that:
editors/README.mdgets 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.versionin the Cameo pom, and theopensysml-clientdependency in the SysON backend pom) are locked toclient/java/pom.xml, and names the existing gate that enforces this:test_every_in_repo_reference_names_the_poms_versioninclient/python/tests/test_check_version.py, which the PR workflow runs whenever either editor pom changes (viascripts/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-checkpasses.python3 scripts/changelog.py checkpasses.develop:pytest tests/test_check_version.py -k in_repo_reference.Checklist
make testandmake lintpass locally (n/a: docs only)changes/unreleased/<slug>.<section>.md, not as an edit toCHANGELOG.md(n/a: nothing a user sees changes)make docs-countsrun if a gate count moved (n/a)F4,K5) in the body, docs, or changelogLink 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