docs: update release documentation #7519
Open
Conversation
This file contains 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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #7519 +/- ##
==========================================
- Coverage 55.48% 55.13% -0.35%
==========================================
Files 672 672
Lines 26961 26961
Branches 2620 2620
==========================================
- Hits 14958 14864 -94
- Misses 11286 11378 +92
- Partials 717 719 +2
see 14 files with indirect coverage changes Continue to review full report in Codecov by Sentry.
|
unlikelyzero
commented
Feb 22, 2024
| Versioning is a critical step for package release. The Open MCT team follows [Semantic Versioning (SemVer)](https://semver.org) that consists of three major components: MAJOR.MINOR.PATCH. These ensure a structured process for updating, bug fixes, backward compatibility, and software progress. | ||
| Versioning is a critical step for package release. Open MCT follows [Semantic Versioning 2.0.0 (SemVer)](https://semver.org) that consists of three major components: MAJOR.MINOR.PATCH. These ensure a structured process for updating, bug fixes, backward compatibility, and software progress. | ||
|
|
||
| Major releases are necessitated by fundamental framework changes that are expected to be incompatible |
There was a problem hiding this comment.
Angular -> Vue2+TimeAPI Deprecation warning -> Vue3+ES6 Shim -> Vue3 + ESM
unlikelyzero
commented
Feb 22, 2024
| Major releases are necessitated by fundamental framework changes that are expected to be incompatible | ||
| with previous releases. | ||
|
|
||
| Minor releases are necessitated by non-backwards-compatible application, API changes, or new |
There was a problem hiding this comment.
the standard.
unlikelyzero
commented
Feb 22, 2024
docs/src/process/release.md
Outdated
| - **API Change** | ||
| - Signifies when a contribution makes any complete or under layer changes to the communication or its supporting access processes. This label flags required see-through insight on how the web-based control panel sees and manipulates any value and or network logs. | ||
| - **Default Behavior Change** | ||
| - In the incident an update either adjusts a form to or integrates a not previously kept setting or plugin. i.e. autoscale is enabled by default when working with plots. | ||
|
|
||
| ## 6. Community & Contributions | ||
|
|
There was a problem hiding this comment.
Add section on deprecation.
Summary Widget Deprecated Example.
- Notify Users
- Supposed to write interceptor to convert to conditionWidgets
- Deprecation warning
unlikelyzero
commented
Feb 22, 2024
| ## 1. Pre-requisites | ||
|
|
||
| Before releasing a new version of the NASA Open MCT NPM package, ensure all dependencies are updated, and comprehensive tests are performed. This ensures compatibility and performance of the Open MCT within the Node.js ecosystem. | ||
| Before releasing a new version of Open MCT, ensure that all dependencies are updated, and | ||
| comprehensive testing is performed. |
There was a problem hiding this comment.
Define "core" plugin and "peripheral" plugin
unlikelyzero
requested review from
charlesh88,
davetsay,
akhenry,
shefalijoshi,
ozyx,
jvigliotta and
rukmini-bose
ozyx
changed the title
charlesh88
reviewed
Mar 21, 2024
| - [NPM](https://www.npmjs.com/package/openmct) | ||
| - [Github Releases](https://github.com/nasa/openmct/releases) | ||
| 2. What do we publish? | ||
| - What constitutes a "stable" release? |
There was a problem hiding this comment.
Shouldn't the different release types be clustered under another header, like
What kinds of releases do we publish?
- Stable: blah blah
- Latest: The most recently published release.
- Nightly: yada yada
| - **Breaking Change** | ||
| - Highlights the integration of changes that are suspected to break, or without a doubt will | ||
| break, backwards compatibility. These should signal to users the upgrade might be seamless only | ||
| if dependency and integration factors are properly managed, if not, one should expect to manage |
There was a problem hiding this comment.
...properly managed, and if not, one should...
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.
Closes #7534
Describe your changes:
Quick pass on updating our release note documentation
All Submissions:
Author Checklist
type:label? Note: this is not necessarily the same as the original issue.Reviewer Checklist